diff options
| author | Aaron Nunley <aaron@rocketsociety.com> | 2021-01-31 20:29:40 -0800 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2021-02-02 01:02:54 -0500 |
| commit | bcc3d9b5a6acb9f39cdae1544e334ec733c6ad6e (patch) | |
| tree | 4fe954dde2845c37f03183e9650c62bb23de8cd3 | |
| parent | 592b98cd12535378b73e812814979541bc981368 (diff) | |
Update build/flash documentation.
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.
| -rw-r--r-- | docs/docs/development/build-flash.md | 14 | ||||
| -rw-r--r-- | docs/docs/development/new-shield.md | 3 |
2 files changed, 12 insertions, 5 deletions
diff --git a/docs/docs/development/build-flash.md b/docs/docs/development/build-flash.md index e270a7c..acabfc0 100644 --- a/docs/docs/development/build-flash.md +++ b/docs/docs/development/build-flash.md @@ -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`. diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md index d701a2c..d82cb8e 100644 --- a/docs/docs/development/new-shield.md +++ b/docs/docs/development/new-shield.md @@ -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 |