diff options
| author | Aaron Nunley <aaron@rocketsociety.com> | 2021-01-31 19:10:46 -0800 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2021-02-02 01:02:54 -0500 |
| commit | 100d06ae8b37926b2211ff856f3ab21ba094e8c0 (patch) | |
| tree | 45241b1a921bfc7e423fcc0729ceac11787823ab /docs | |
| parent | 33cd2cacede8ccadab099abe49735bacf0a0b76e (diff) | |
Update docs for testing a new shield.
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/development/new-shield.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md index 6fac207..25d59fc 100644 --- a/docs/docs/development/new-shield.md +++ b/docs/docs/development/new-shield.md @@ -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) |