summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/development/new-shield.md11
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)