Merge pull request #137 from StarlingUAS/dev

Updates PX4 Version to latest and General Usage Tutorial

README.md

@@ -43,11 +43,11 @@ By virtue of the architecture, the system also includes failure recovery and det
 ## Contact
 The initial developers of this project are:
 
-- Mickey Li - [email](mailto:[email protected]) - [github](github.com/mhl787156)
-- Robert Clarke - [email](mailto:[email protected]) - [github](github.com/rob-clarke)
+- Mickey Li - [email](mailto:[email protected]) - [github](https://github.com/mhl787156)
+- Robert Clarke - [email](mailto:[email protected]) - [github](https://github.com/rob-clarke)
 
 ## FAQs
-Please see documentation, or raise an [Issue on the github repo](github.com/UoBFlightLab/ProjectStarling/issues)
+Please see documentation, or raise an [Issue on the github repo](https://github.com/StarlingUAS/ProjectStarling/issues)
 
 ## License
-This project is released under the MIT license. Please see the [License file](https://github.com/UoBFlightLab/ProjectStarling/blob/master/LICENSE) for more details.
+This project is released under the MIT license. Please see the [License file](https://github.com/StarlingUAS/ProjectStarling/blob/master/LICENSE) for more details.

docker-compose-2-drones.yml

@@ -20,6 +20,7 @@ services:
       - "PX4_SIM_HOST=localhost"
       - "PX4_INSTANCE=0"
       - "IGNORE_FAILURE=true"
+      - "ENABLE_VIRTUAL_FRAMEBUFFER=false"
     depends_on:
       - simhost
     pid: "host" # Share Process ID Namespace
@@ -70,6 +71,7 @@ services:
       - "PX4_INSTANCE=1"
       - "IGNORE_FAILURE=true"
       - "PX4_SIM_INIT_LOC_X=2"
+      - "ENABLE_VIRTUAL_FRAMEBUFFER=false"
     depends_on:
       - simhost
     pid: "host" # Share Process ID Namespace

docs/README.md

@@ -12,7 +12,7 @@ This systems provides a number of key features.
 - Built in simulation stack based on Gazebo
 - Quick transition from simulation to flying controllers on real drones.
 
-![Simple Architecture](/img/ArchSimple.jpg)
+![Simple Architecture](img/ArchSimple.jpg)
 
 ## Documentation
 
@@ -43,11 +43,11 @@ By virtue of the architecture, the system also includes failure recovery and det
 ## Contact
 The initial developers of this project are:
 
-- Mickey Li - [email](mailto:[email protected]) - [github](github.com/mhl787156)
-- Robert Clarke - [email](mailto:[email protected]) - [github](github.com/rob-clarke)
+- Mickey Li - [email](mailto:[email protected]) - [github](https://github.com/mhl787156)
+- Robert Clarke - [email](mailto:[email protected]) - [github](https://github.com/rob-clarke)
 
 ## FAQs
-Please see documentation, or raise an [Issue on the github repo](github.com/UoBFlightLab/ProjectStarling/issues)
+Please see documentation, or raise an [Issue on the github repo](https://github.com/StarlingUAS/ProjectStarling/issues)
 
 ## License
-This project is released under the MIT license. Please see the [License file](https://github.com/UoBFlightLab/ProjectStarling/blob/master/LICENSE) for more details.
+This project is released under the MIT license. Please see the [License file](https://github.com/StarlingUAS/ProjectStarling/blob/master/LICENSE) for more details.

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.
 
@@ -43,7 +43,7 @@ This will install Docker, accessible using `sudo` root privileges only. To use d
         sudo groupadd docker
         sudo usermod -aG docker $USER
 
-2. Log out and log in again to enforce changes
+2. Log out and log in again to enforce changes (may need to restart)
 3. Verify that it was successful:
 
         docker run hello-world
@@ -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.

docs/kbd.css

@@ -0,0 +1,13 @@
+kbd > kbd {
+    background-color: #eee;
+    border-radius: 3px;
+    border: 1px solid #b4b4b4;
+    box-shadow: 0 1px 1px rgba(0, 0, 0, .2), 0 2px 0 0 rgba(255, 255, 255, .7) inset;
+    color: #333;
+    display: inline-block;
+    font-size: .85em;
+    font-weight: 700;
+    line-height: 1;
+    padding: 2px 4px;
+    white-space: nowrap;
+   }

docs/other/ideas.md

@@ -1,3 +1,3 @@
-### `ros.env.d`
+# `ros.env.d`
 Adding a folder to a `/ros.env.d` could provide an extendable way to add to the
 ros environment. e.g. including additional model/plugin paths for Gazebo.

docs/requirements.txt

@@ -1,2 +1,5 @@
 mkdocs
 mkdocs-macros-plugin
+pymdown-extensions
+mkdocs-enumerate-headings-plugin
+mkdocs-mermaid2-plugin