From ace454e45016b1d50cb4e3c72bf8c1ce8ecf46a1 Mon Sep 17 00:00:00 2001 From: Jaimyn Mayer Date: Mon, 7 Aug 2017 22:25:50 +1000 Subject: [PATCH] Added links to quick start, solo/artoo directories Added links to the quick start guide on the ardupilot wiki and to the solo/artoo folders. Also added notes about building everything. --- documentation/README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index 51c7396..4836bbd 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,2 +1,19 @@ -# documentation -A temporary place to store documentation. It's location will probably change once we setup a proper wiki. +> Disclaimer: Open Solo is a work in progress! You will almost certainly brick your Solo or controller if you follow these instructions! + +# Open Solo Documentation +A temporary place to store documentation. It's location will probably change once we setup a proper wiki. The solo controller is often called "artoo" - that is what's primarily used in this documentation. + +## [Building Open Solo (everything)](http://ardupilot.org/dev/docs/solo-opensolo-quickstart.html) +If you want to build Open Solo, take a look at the [quick start guide](http://ardupilot.org/dev/docs/solo-opensolo-quickstart.html). It contains everything you need to build all components of Open Solo from scratch and push it to your solo/artoo. If you want to make customisations or build something specific take a look below. +> Note: solo-builder is producing corrupt artoo stm32 binaries for some users. Take a look below if your artoo becomes "bricked" or doesn't turn on. + +## [Artoo (the controller)](https://github.com/OpenSolo/documentation/tree/master/artoo) + +[How to build the stm32 firmware](https://github.com/OpenSolo/documentation/tree/master/artoo) (Coming soon...) + +[How to customise images/icons](https://github.com/OpenSolo/documentation/tree/master/artoo) (Coming soon...) + +[How to customise strings/text](https://github.com/OpenSolo/documentation/tree/master/artoo) (Coming soon...) + +## [Solo](https://github.com/OpenSolo/documentation/tree/master/solo) +Nothing yet :(