pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update build/flash documentation.

Browse source 
Updated docs for the build and flash to have similar content to the new board page.

Added a bit about DFU in case someone were searching for that term.
This commit is contained in:
Aaron Nunley 2021-01-31 20:29:40 -08:00 committed by Pete Johanson
parent 592b98cd12
commit bcc3d9b5a6
2 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/docs/development/build-flash.md
View file

@ -118,11 +118,17 @@ Now start VSCode and rebuild the container after being prompted. You should be a
## Flashing
Once built, the previously supplied parameters will be remembered so you can run the following to flash your
board with it in bootloader mode:
The above build commands generate a UF2 file in `build/zephyr` (or
`build/left|right/zephyr` if you followed the instructions for splits) and is by
default named `zmk.uf2`. If your board supports USB Flashing Format (UF2), copy
that file onto the root of the USB mass storage device for your board. The
controller should flash your built firmware and automatically restart once
flashing is complete.
Alternatively, if your board supports flashing and you're not developing from
within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on
your board and run the following command to flash:
```
west flash
```
For boards that have drag and drop .uf2 flashing capability, the .uf2 file to flash can be found in `build/zephyr` (or `build/left|right/zephyr` if you followed the instructions for splits) and is by default named `zmk.uf2`.

3
docs/docs/development/new-shield.md
View file

@ -469,7 +469,8 @@ storage device for your board. The controller should flash your built firmware
and automatically restart once flashing is complete.
Alternatively, if your board supports flashing and you're not developing from
within a Dockerized environment, then you can test your build with:
within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on
your board and run the following command to test your build:
```
west flash