Skip to content

Commit

Permalink
Added Get Starling, relabelled Docker install section
Browse files Browse the repository at this point in the history
Following install instructions 'blindly' as a test user - there wasn't a `git clone` between this guide and the single-drone guide.
  • Loading branch information
bullox authored Dec 14, 2021
1 parent 472eef9 commit 93617d7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Contents
[TOC]

## Installation
## Install Docker

The only dependency of running and using Starling locally is the [Docker] containerisation software. Please visit [docker's installation page](https://docs.docker.com/get-docker/) for further details. We recommend using Starling on linux based systems, but it should work on Windows and possible Mac depending on the state of the Docker.

Expand Down Expand Up @@ -62,6 +62,12 @@ For Mav systems, please see [the Mac Os installation instructions](https://docs.

Starling has not be tested on MAC OS, so there is no guarantee that it is functional. However in theory the single-agent non-cluster (docker-only) application should be compatible.

## Get Starling

Clone the Starling repository:

git clone https://github.com/StarlingUAS/ProjectStarling.git

## Using Starling

Starling provides a framework for users to implement almost any drone related experiment or application. However, we have identified that most applications fall into the following categories. Therefore we have provided detailed user guides for these use cases. It is recommended that the user follow these guides to run starling before starting your own implementation as these guides will also slowly introduce you to the concepts and details Starling uses.
Expand Down

0 comments on commit 93617d7

Please sign in to comment.