Mirrors/OpenSolo
1
0
Fork 0
mirror of https://github.com/OpenSolo/OpenSolo.git synced 2025-04-29 22:24:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOC: Readme update for new solo-builder and artoo readmes

Browse Source
This commit is contained in:
Matt Lawrence 2019-01-07 18:26:35 -05:00 committed by Matt
parent ccae7d9bd7
commit ab86b5be05
1 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -1,17 +1,21 @@
# WELCOME TO OPEN SOLO # # WELCOME TO OPEN SOLO #
***NEW: CONSOLIDTED REPOSITORY IS HERE*** ## Annoucements ##
***NEW: CONSOLIDTED REPOSITORY IS HERE***
Many of the seperate github repositories for the various aspects of Open Solo have been consolidated into one central repo, which is where you are now. Anything that wasn't a fork of another repo has been converted to a subdirectory of this repo. This includes sololink, shotmanager, solo-builder, artoo, sololink-python, stm32loader, meta-3dr, and yocto base. Conveniently, these are the repos that see the most ongoing development. As such, it will be much easier to manage that work in one place. Releases, tags, and branches will have some logic and consistency. The commit history from the old separate repos has been retained and all show up here still, so history is not lost or forgotten. Many of the seperate github repositories for the various aspects of Open Solo have been consolidated into one central repo, which is where you are now. Anything that wasn't a fork of another repo has been converted to a subdirectory of this repo. This includes sololink, shotmanager, solo-builder, artoo, sololink-python, stm32loader, meta-3dr, and yocto base. Conveniently, these are the repos that see the most ongoing development. As such, it will be much easier to manage that work in one place. Releases, tags, and branches will have some logic and consistency. The commit history from the old separate repos has been retained and all show up here still, so history is not lost or forgotten.
Mavproxy and mavlink-solo remain separate repos, included here as submodules. These are forks from ArduPilot, and shall remain in their repos for that reason. Ultimately, it would be great to just use the master ArduPilot repos, but the Solo's firmware is too old. So these forks are circa 2016. The imx6-linux and imx6-uboot are also still in their own repos. They are forks, and have tens of thousands of commits each. They also are untouched since 2016, and will probably remain so. Mavproxy and mavlink-solo remain separate repos, included here as submodules. These are forks from ArduPilot, and shall remain in their repos for that reason. Ultimately, it would be great to just use the master ArduPilot repos, but the Solo's firmware is too old. So these forks are circa 2016. The imx6-linux and imx6-uboot are also still in their own repos. They are forks, and have tens of thousands of commits each. They also are untouched since 2016, and will probably remain so.
ArduPilot-solo is the repo for the old stock ArduCopter firmware from 3DR. It is a fork from ArduPilot, stale since 2016 other than one commit for Open Solo 3. This will as such be remaining its own repo, included here as a submodule for reference. Once ArduCopter 3.7 stable is released, this repo will be obsolete and deprecated. ArduPilot-solo is the repo for the old stock ArduCopter firmware from 3DR. It is a fork from ArduPilot, stale since 2016 other than one commit for Open Solo 3. This will as such be remaining its own repo, included here as a submodule for reference. Once ArduCopter 3.7 stable is released, this repo will be obsolete and deprecated.
***
## ARDUCOPTER 3.7-DEV TESTING ## ## ARDUCOPTER 3.7-DEV TESTING ##
[Click here for release notes and instructions](../master/documentation/install_solex.md) as of December 8, 2018 for beta testing ArduCopter 3.7-dev on the Solo. You must already be on Open Solo to do this. This is a major beta testing project. [Click here for release notes and instructions](/documentation/copter37.md) as of December 8, 2018 for beta testing ArduCopter 3.7-dev on the Solo. You must already be on Open Solo to do this. This is a major beta testing project.
---
## OPEN SOLO v3.0.0 STABLE RELEASE ON JANUARY 1, 2018 ## ## OPEN SOLO v3.0.0 STABLE RELEASE ON JANUARY 1, 2018 ##
@ -24,14 +28,15 @@ The team working on safe, reliable releases of Open Solo publishes them here. Yo
- [All releases including old betas](https://github.com/OpenSolo/documentation/releases/) - [All releases including old betas](https://github.com/OpenSolo/documentation/releases/)
- For _stock solos and previously installed and working green cubes_, go straight to the Open Solo installation procedures: - For _stock solos and previously installed and working green cubes_, go straight to the Open Solo installation procedures:
- [Install using the Solex app on Android](../master/documentation/install_solex.md) - [Install using the Solex app on Android](/documentation/install_solex.md)
- [Install using SidePilot app on iOS](../master/documentation/initial_sidepilot.md) - [Install using SidePilot app on iOS](/documentation/initial_sidepilot.md)
- [Install using SSH/SFTP on widows or mac](../master/documentation/initial_ssh.md) - [Install using SSH/SFTP on widows or mac](/documentation/initial_ssh.md)
- [Install / recovery with SD card images](../master/documentation/install_sdimage.md) - [Install / recovery with SD card images](/documentation/install_sdimage.md)
- For a _brand new Green Cube installation_ please follow these updated instructions! - For a _brand new Green Cube installation_ please follow these updated instructions!
- [New green cube installation procedure](../master/documentation/green_cube_install.md) - [New green cube installation procedure](/documentation/green_cube_install.md)
***
## Support, Social Media, and other useful links ## ## Support, Social Media, and other useful links ##
@ -49,6 +54,7 @@ The team working on safe, reliable releases of Open Solo publishes them here. Yo
* [Filezilla](https://filezilla-project.org/download.php?type=client) for moving files to/from the companion computer * [Filezilla](https://filezilla-project.org/download.php?type=client) for moving files to/from the companion computer
* [WinSCP](https://winscp.net/eng/download.php) for moving files to/from the companion computer * [WinSCP](https://winscp.net/eng/download.php) for moving files to/from the companion computer
***
## Tech and Contributors ## ## Tech and Contributors ##
If you're the geeky type that wants to read all the commits to see what has been changed in Open Solo, they can all be found in the Open Solo github repositories. If you're the geeky type that wants to read all the commits to see what has been changed in Open Solo, they can all be found in the Open Solo github repositories.
@ -65,35 +71,28 @@ If you're the geeky type that wants to read all the commits to see what has been
- [Sololink-python](https://github.com/OpenSolo/sololink-python/commits/master) is some misc helper python files. - [Sololink-python](https://github.com/OpenSolo/sololink-python/commits/master) is some misc helper python files.
- [ArduPilot-solo](https://github.com/OpenSolo/ardupilot-solo/commits/master) is 3DR's fork of ArduCopter used on the stock Solo pixhawk 2.0 cube. - [ArduPilot-solo](https://github.com/OpenSolo/ardupilot-solo/commits/master) is 3DR's fork of ArduCopter used on the stock Solo pixhawk 2.0 cube.
***
## For Developers ## ## For Developers ##
***FOR DEVELOPERS!! Not for general users that just want to put Open Solo releases on their solo!!!***
***NEEDS UPDATING***
### [Building Open Solo (everything)](https://github.com/OpenSolo/documentation/blob/master/SOLO-BUILDER.md) ### ***Not for general users that just want to put Open Solo releases on their solo!!!***
### Building Firmware ###
If you want to build Open Solo, take a look at solo-builder [here](https://github.com/OpenSolo/documentation/blob/master/SOLO-BUILDER.md). It contains everything you need to build OpenSolo from scratch and update your artoo/solo. If you want to make customisations or build something specific take a look below. * Visit the [Open Solo Vagrant VM readme](/vagrant_readme.md) for first time installation and initialization of the Vagrant VM.
> Note: solo-builder is producing corrupt artoo stm32 binaries for some users. See the [artoo docs](https://github.com/OpenSolo/documentation/tree/master/artoo) if your artoo becomes "bricked" or doesn't turn on. (this is normally easily recoverable) * Visit [solo-builder](/solo-builder) for steps to build the complete copter and controller firmware.
* Visit [artoo](/artoo) for steps to build just the Artoo STM32 firmware
### [Artoo (the controller)](https://github.com/OpenSolo/documentation/tree/master/artoo) ### ### TO-DO ###
[How to build the stm32 firmware](https://github.com/OpenSolo/documentation/blob/master/artoo/build-artoo-firmware.md) Add to readme information on ArduCopter compatibility and building
[How to flash the stm32 firmware](https://github.com/OpenSolo/documentation/blob/master/artoo/flash-custom-firmware.md) ***
[How to unbrick artoo](https://github.com/OpenSolo/documentation/blob/master/artoo/flash-custom-firmware.md#bricked-artoo)
[How to customise start/shutdown image](https://github.com/OpenSolo/documentation/blob/master/artoo/customisation/custom-boot-screen.md)
[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 :(
## How to get involved ## ## How to get involved ##
This documentation is pretty empty right now. If you know how Solo or Artoo works (or don't know!) and want to get involved pull requests are welcome on this documentation and all of the sub projects. (artoo, solo-builder etc) Most of the developers are hanging out on [gitter](https://gitter.im/ArduPilot/OpenSolo) and [Facebook](https://www.facebook.com/groups/3DRSOLOModClub/). This documentation is pretty empty right now. If you know how Solo or Artoo works (or don't know!) and want to get involved pull requests are welcome on this documentation and all of the sub projects. (artoo, solo-builder etc) Most of the developers are hanging out on [gitter](https://gitter.im/ArduPilot/OpenSolo) and [Facebook](https://www.facebook.com/groups/3DRSOLOModClub/).
***
## Special Mentions! ## ## Special Mentions! ##
All of this would not be possible without 3DR. They very generously open sourced most of their internal code and build tools to make this possible. You can see the official 3DR release statement [here](https://3dr.com/blog/announcing-opensolo/) and the ardupilot team's statement [here](https://discuss.ardupilot.org/t/opensolo-initiative-by-the-ardupilot-team). All of this would not be possible without 3DR. They very generously open sourced most of their internal code and build tools to make this possible. You can see the official 3DR release statement [here](https://3dr.com/blog/announcing-opensolo/) and the ardupilot team's statement [here](https://discuss.ardupilot.org/t/opensolo-initiative-by-the-ardupilot-team).