Update README.md
This commit is contained in:
parent
3d94ca8c7b
commit
7fa10355e0
21
README.md
21
README.md
|
@ -2,3 +2,24 @@
|
|||
|
||||
This is just the SDK from the wiki (so far), with dockerfile setup to make building easier, and my reverse engineered bestool integrated.
|
||||
The docker image will build bestool for you first, then drop you into the dev container for building and flashing the buds.
|
||||
|
||||
## Usage
|
||||
|
||||
To use this setup to build & flash your pine buds you will need a system with docker setup at the minimum.
|
||||
Docker is used to (1) make this all much more reprodicible and easier to debug and (2) so that we dont mess with your host system at all.
|
||||
In order to program the buds from inside of the docker container; privileged mode is used. So do be a tad more careful than usual.
|
||||
|
||||
```bash
|
||||
|
||||
./start_dev.sh # This will cause docker to start your working environment; this should take roughly 1-3 minutes depending on your network speed to the GCC hosting server
|
||||
|
||||
# Now you will be inside of the container, and your prompt will look akin to "root@ec5410d0a265:/usr/src#"
|
||||
|
||||
./build.sh # This will run make and build the output program. If you have weird build errors try running clean.sh or rm -rf'ing the out folder first
|
||||
|
||||
# Now that the firmware has finished building; if there are no errors you can load it to your buds
|
||||
# Assuming that your serial ports are 0 and 1, run the following to commands to program each bud in series.
|
||||
# You may need to take the buds out of the case, wait three seconds, place them back. This wakes them up.
|
||||
bestool write-image out/open_source/open_source.bin --port /dev/ttyACM0
|
||||
bestool write-image out/open_source/open_source.bin --port /dev/ttyACM1
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue