diff options
author | kurtis-lew <kurtis.a.lew@gmail.com> | 2020-10-08 22:16:53 -0700 |
---|---|---|
committer | kurtis-lew <kurtis.a.lew@gmail.com> | 2020-10-08 22:16:53 -0700 |
commit | a9ec1148e50ff0601f82c9eb55b90c33e7c70dab (patch) | |
tree | 1b7edbc36d636e5010de04e01017e51e849c7093 | |
parent | 12b9a37005cade72ad85134b8cfe31ccefec500d (diff) |
Added -DZMK_CONFIG Documentation
-rw-r--r-- | docs/docs/dev-build.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/docs/dev-build.md b/docs/docs/dev-build.md index 816468e..a7c1cd9 100644 --- a/docs/docs/dev-build.md +++ b/docs/docs/dev-build.md @@ -84,6 +84,19 @@ west build -d build/right -b nice_nano -- -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. +### Building from `zmk-config` Folder + +Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](user-setup.md) by adding +`-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.** + + +For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder on Windows 10 may look something like this: + +``` +west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Documents/Github/zmk-config/config" +``` + + ## Flashing Once built, the previously supplied parameters will be remembered so you can run the following to flash your |