History

KemoNine f59daa6e3d Adjust tidbit keymap to be more in line with daily use needs		2021-01-08 23:20:25 +00:00
..
config	Adjust tidbit keymap to be more in line with daily use needs	2021-01-08 23:20:25 +00:00
vscode	Rearrange folder layout now that upstream projects aren't mirrored inside this repo	2021-01-05 07:17:41 -05:00
notes.md	Rearrange folder layout now that upstream projects aren't mirrored inside this repo	2021-01-05 07:17:41 -05:00
README.md	Add notes on how to setup commitlint+husky	2021-01-08 20:16:00 +00:00

README.md

ZMK Notes

Docker Volume

Need to have the zmk-config directory mounted at /workspaces/zmk-config in Docker container

git commit linting setup

Issue 575 on GitHub

# 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

Building


west build --board nice_nano -d build/m60 -- -DSHIELD=m60 -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board nice_nano -d build/tidbit -- -DSHIELD=tidbit -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board nrf52840_mdk_dongle -d build/pockettype/central -- -DSHIELD=pockettype_central -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board nice_nano -d build/pockettype/peripheral -- -DSHIELD=pockettype_peripheral -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board nice_nano -d build/tg4x -- -DSHIELD=tg4x -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

west build --board nrf52840_mdk_dongle -d build/mdk_dongle -- -DSHIELD=mdk_dongle -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board itsybitsy_nrf52840 -d build/azarashi64/left -- -DSHIELD=azarashi64_left -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config

west build --board itsybitsy_nrf52840 -d build/azarashi64/right -- -DSHIELD=azarashi64_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-config/config