Skip to content

Commit

Permalink
Move firmware compile to contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
LucHeart committed Oct 31, 2024
1 parent 3183a5c commit 81f159b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
8 changes: 6 additions & 2 deletions docs/diy/compile.md → docs/contributing/compile-firmware.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ nav:
- Do It Yourself:
- Hardware:
- diy/assembling.md
- Software:
- diy/compile.md

- Developer: dev/index.md

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 81f159b

Please sign in to comment.