kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): Update boards in build examples to common+uf2 ones

Browse source
This commit is contained in:
Cem Aksoylar 2023-11-10 22:08:37 -08:00 • committed by Pete Johanson
parent c1bf35ce1d
commit 2554b5c88f
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -65,7 +65,7 @@ west build -b planck_rev6
When building for a new board and/or shield after having built one previously, you may need to enable the pristine build option. This option removes all existing files in the build directory before regenerating them, and can be enabled by adding either --pristine or -p to the command: When building for a new board and/or shield after having built one previously, you may need to enable the pristine build option. This option removes all existing files in the build directory before regenerating them, and can be enabled by adding either --pristine or -p to the command:
```sh ```sh
west build -p -b proton_c -- -DSHIELD=kyria_left west build -p -b nice_nano_v2 -- -DSHIELD=kyria_left
``` ```
### Building For Split Keyboards ### Building For Split Keyboards
@ -77,13 +77,13 @@ For split keyboards, you will have to build and flash each side separately the f
By default, the `build` command outputs a single .uf2 file named `zmk.uf2` so building left and then right immediately after will overwrite your left firmware. In addition, you will need to pristine build each side to ensure the correct files are used. To avoid having to pristine build every time and separate the left and right build files, we recommend setting up separate build directories for each half. You can do this by using the `-d` parameter and first building left into `build/left`: By default, the `build` command outputs a single .uf2 file named `zmk.uf2` so building left and then right immediately after will overwrite your left firmware. In addition, you will need to pristine build each side to ensure the correct files are used. To avoid having to pristine build every time and separate the left and right build files, we recommend setting up separate build directories for each half. You can do this by using the `-d` parameter and first building left into `build/left`:
```sh ```sh
west build -d build/left -b nice_nano -- -DSHIELD=kyria_left west build -d build/left -b nice_nano_v2 -- -DSHIELD=kyria_left
``` ```
and then building right into `build/right`: and then building right into `build/right`:
```sh ```sh
west build -d build/right -b nice_nano -- -DSHIELD=kyria_right west build -d build/right -b nice_nano_v2 -- -DSHIELD=kyria_right
``` ```
This produces `left` and `right` subfolders under the `build` directory and two separate .uf2 files. For future work on a specific half, use the `-d` parameter again to ensure you are building into the correct location. This produces `left` and `right` subfolders under the `build` directory and two separate .uf2 files. For future work on a specific half, use the `-d` parameter again to ensure you are building into the correct location.

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

@ -493,7 +493,7 @@ Once you've fully created the new keyboard shield definition,
you should be able to test with a build command like: you should be able to test with a build command like:
```sh ```sh
west build --pristine -b proton_c -- -DSHIELD=my_board west build --pristine -b nice_nano_v2 -- -DSHIELD=my_board
``` ```
The above build command generates `build/zephyr/zmk.uf2`. If your board The above build command generates `build/zephyr/zmk.uf2`. If your board