From 93617d781d0cdd9b376443b9d0a3455c481a75be Mon Sep 17 00:00:00 2001 From: Steve Bullock Date: Tue, 14 Dec 2021 10:45:35 +0000 Subject: [PATCH] Added Get Starling, relabelled Docker install section Following install instructions 'blindly' as a test user - there wasn't a `git clone` between this guide and the single-drone guide. --- docs/guide/getting-started.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 919fa2d..fc94444 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -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. @@ -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.