Add "Getting Started - Software" guide

ebelski / rust-copter

A quadcopter build using a Teensy running Rust and some other cool stuff that's yet to be determined.

MIT License

6 stars 1 forks source link

Add "Getting Started - Software" guide #35

Closed mciantyre closed 3 years ago

mciantyre commented 3 years ago

Add a written guide for first-time software installation
Include a shell script to automate most of that first-time software installation (Linux / macOS only)
Test that shell script

Looking for feedback on the docs quality, making sure that its easy to read, and that it includes all of the dependencies and tools.

mciantyre commented 3 years ago

Checks for first-time-setup.sh passed in CI. I transitioned the test to a cron job, instead of running them on every PR / commit, since they run slower (need to download toolchains, build tools, build all code). Could use a dependency cache to avoid the crate download, but lets consider that if the cron job doesn't work out.

mciantyre commented 3 years ago

Consider this getting started documentation for #23.