2020-12-19 22:34:40 +00:00
|
|
|
# ZMK Notes
|
2020-12-04 22:43:05 +00:00
|
|
|
|
|
|
|
|
## Docker Volume
|
|
|
|
|
|
2020-12-05 23:27:34 +00:00
|
|
|
Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in Docker container
|
2020-12-04 22:43:05 +00:00
|
|
|
|
2021-01-08 20:16:00 +00:00
|
|
|
## git commit linting setup
|
|
|
|
|
|
|
|
|
|
Issue 575 on GitHub
|
|
|
|
|
|
|
|
|
|
``` sh
|
|
|
|
|
# cd /path/to/zmk
|
|
|
|
|
npm install --save-dev @commitlint/{cli,config-conventional}
|
|
|
|
|
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
|
|
|
|
|
npm install --save-dev husky@next
|
|
|
|
|
npm install pinst --save-dev
|
|
|
|
|
npx husky install
|
|
|
|
|
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
|
|
|
|
|
npx commitlint --from HEAD~1 --to HEAD --verbose
|
|
|
|
|
touch foo
|
|
|
|
|
git commit -m "foo: this will fail"
|
|
|
|
|
git commit -m "chore: lint on commitmsg"
|
|
|
|
|
git reset HEAD~1
|
|
|
|
|
rm foo
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
2020-12-04 22:43:05 +00:00
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
``` sh
|
|
|
|
|
|
2021-01-19 03:14:14 +00:00
|
|
|
west build --board nice_nano -d build/nibble -- -DSHIELD=nibble -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
2021-02-02 05:09:26 +00:00
|
|
|
west build --board nice_nano -d build/tidbit -- -DSHIELD=tidbit -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2021-01-02 04:58:58 +00:00
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board nrf52840_mdk_dongle -d build/pockettype/central -- -DSHIELD=pockettype_central -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2021-01-02 04:58:58 +00:00
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board nice_nano -d build/pockettype/peripheral -- -DSHIELD=pockettype_peripheral -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-26 21:33:37 +00:00
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board nice_nano -d build/tg4x -- -DSHIELD=tg4x -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-26 21:33:37 +00:00
|
|
|
|
2021-02-02 05:09:26 +00:00
|
|
|
west build --board nice_nano -d build/steno_right_lily58 -- -DSHIELD=steno_right_lily58 -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-19 22:34:40 +00:00
|
|
|
|
2021-02-06 02:16:48 +00:00
|
|
|
west build --board nice_nano -d build/steno_left_lily58 -- -DSHIELD=steno_left_lily58 -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
2021-02-02 05:09:26 +00:00
|
|
|
west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-19 22:34:40 +00:00
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board nrf52840_mdk_dongle -d build/mdk_dongle -- -DSHIELD=mdk_dongle -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2021-01-05 08:18:21 +00:00
|
|
|
|
2021-02-02 05:09:26 +00:00
|
|
|
west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
|
|
|
|
west build --board nice_nano -d build/lily58/left -- -DSHIELD=lily58_left -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
|
|
|
|
west build --board nice_nano -d build/lily58/right -- -DSHIELD=lily58_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
2021-02-06 02:16:48 +00:00
|
|
|
west build --board nice_nano -d build/m60 -- -DSHIELD=m60 -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
|
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board itsybitsy_nrf52840 -d build/azarashi64/left -- -DSHIELD=azarashi64_left -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-20 21:02:10 +00:00
|
|
|
|
2021-01-05 12:17:41 +00:00
|
|
|
west build --board itsybitsy_nrf52840 -d build/azarashi64/right -- -DSHIELD=azarashi64_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config
|
2020-12-20 21:02:10 +00:00
|
|
|
|
2020-12-04 22:43:05 +00:00
|
|
|
```
|
