readme.org - ZMK Docker Build Subsection

[axiom-nz]

Issue

The Local Build section of readme.org specifies that ZMK_CONFIG be set to the absolute path of the config directory.

When using the local docker build environment, following these instructions would lead the user to create their zmk-config docker volume with a device path set to config.

Doing so will exclude the Miryoku code from the volume, and any build will fail.

Failing Build

With miryoku_zmk/config provided as the device path.

docker volume create --driver local -o o=bind -o type=none -o device="/var/code/miryoku_zmk/config" zmk-config 

west build -p -d build/right -b nice_nano_v2 -- -DSHIELD=corne_right -DZMK_CONFIG="/workspaces/zmk-config/"

Resolution

Adding subsection to the local build documentation to inform those using the docker build environment of this, and give instructions on the correct path.

Successful Build

With miryoku_zmk provided as the device path.

docker volume create --driver local -o o=bind -o type=none -o device="/var/code/miryoku_zmk/" zmk-config 

west build -p -d build/right -b nice_nano_v2 -- -DSHIELD=corne_right -DZMK_CONFIG="/workspaces/zmk-config/config"

---

Let me know if there is any issue with this, or if you would like it phrased differently.