-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move firmware compile to contributing
- Loading branch information
Showing
2 changed files
with
10 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters