diff --git a/docs/diy/compile.md b/docs/contributing/compile-firmware.md similarity index 60% rename from docs/diy/compile.md rename to docs/contributing/compile-firmware.md index 8f74e61..64b4db2 100644 --- a/docs/diy/compile.md +++ b/docs/contributing/compile-firmware.md @@ -1,16 +1,20 @@ -# Compiling from source +# Compiling Firmware !!! info "Still brewing!" This article heavily under development; expect frequent changes. ## Requirements +- [Git](https://git-scm.com/downloads) - [VSCode](https://visualstudio.microsoft.com/#vscode-section) - [PlatformIO IDE](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide) Clone [OpenShock/Firmware](https://github.com/OpenShock/Firmware) to a folder on your PC. +``` +git clone https://github.com/OpenShock/Firmware.git +``` Open the folder you just downloaded with VSCode. Allow time for PlatformIO to initialize the IDE. Once it has completed, pick the project environment based on the board you would like to compile for under the new PlatformIO icon. ![An image showing where to find the icon for 'Pick project environment'](../static/diy/software/compiling/platformio.png) -First, run the `Device > Upload` task, then run `Platform > Upload Filesystem Image`. These tasks auto-build the latest changes and then upload the code to a connected micro-controller. This may require pressing the reset button on your micro-controller, refer to the documentation for your specific board for more information. +First, run the `PlatformIO > Project Tasks > General > Upload` task, then run `Platform > Upload Filesystem Image`. These tasks auto-build the latest changes and then upload the code to a connected micro-controller. This may require pressing the reset button on your micro-controller, refer to the documentation for your specific board for more information. diff --git a/mkdocs.yml b/mkdocs.yml index 7de53f0..fa86d42 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,8 +30,6 @@ nav: - Do It Yourself: - Hardware: - diy/assembling.md - - Software: - - diy/compile.md - Developer: dev/index.md @@ -71,7 +69,10 @@ nav: - Transmitter: - hardware/transmitter/index.md - - Contributing: contributing/contributing.md + - Contributing: + - contributing/contributing.md + - Software: + - contributing/compile-firmware.md - Legal and Privacy: - legal/terms-and-conditions.md