diff options
| author | Ivan Smirnov <isgsmirnov@gmail.com> | 2021-12-28 03:52:16 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-28 10:52:16 +0000 |
| commit | 3114ce00b9676625e60c49c05eb1a91db51deb7b (patch) | |
| tree | de18883ebab3eccc24bf6a125c306fcb9446148f | |
| parent | a562578fd20c6601667206a62910a60ff3a60ee8 (diff) | |
docs: reiterate building from `zmk/app/` (#1031)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
| -rw-r--r-- | docs/docs/development/build-flash.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/docs/development/build-flash.md b/docs/docs/development/build-flash.md index cb00b1a..ac75b83 100644 --- a/docs/docs/development/build-flash.md +++ b/docs/docs/development/build-flash.md @@ -99,6 +99,10 @@ For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Documents/Github/zmk-config/config" ``` +:::caution +The above command must still be invoked from the `zmk/app` directory as noted above, rather than the config directory. Otherwise, you will encounter errors such as `ERROR: source directory "." does not contain a CMakeLists.txt; is this really what you want to build?`. Alternatively you can add the `-s /path/to/zmk/app` flag to your `west` command. +::: + In order to make your `zmk-config` folder available when building within the VSCode Remote Container, you need to create a docker volume named `zmk-config` by binding it to the full path of your config directory. If you have run the VSCode Remote Container before, it is likely that docker has created this volume automatically -- we need to delete the default volume before binding it to the correct path. Follow the following steps: |