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

Update docs for testing a new shield.

Browse source 
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
This commit is contained in:
Aaron Nunley 2021-01-31 19:10:46 -08:00 committed by Pete Johanson
parent 33cd2caced
commit 100d06ae8b
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -463,12 +463,21 @@ you should be able to test with a build command like:
west build --pristine -b proton_c -- -DSHIELD=my_board
```
and then flash with:
The above build command generates `build/zephyr/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, then you can test your build with:
```
west flash
```
Please have a look at documentation specific to
[building and flashing](build-flash) for additional information.
:::note
Further testing your keyboard shield without altering the root keymap file can be done with the use of `-DZMK_CONFIG` in your `west build` command,
shown [here](build-flash#building-from-zmk-config-folder)