kemonine/keyboard
kemonine/keyboard
1
0
Fork 0
Code Issues Pull requests Releases 2 Activity
keyboard/zmk-config/README.md

94 lines
5.2 KiB
Markdown
Raw Normal View History

Add notes re lily58pro
2020-12-19 22:34:40 +00:00
# ZMK Notes
Update personal tidbit config for zmk
2020-12-04 22:43:05 +00:00
## Docker Volume
Adjust zmk-config readme
2020-12-05 23:27:34 +00:00
Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in Docker container
Update personal tidbit config for zmk
2020-12-04 22:43:05 +00:00
Add notes on how to setup commitlint+husky
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
```
Update personal tidbit config for zmk
2020-12-04 22:43:05 +00:00
## Building
``` sh
Move artsey implemenations that are sound to main artseyio github repo
2021-02-19 00:27:25 +00:00
-DCMAKE_EXPORT_COMPILE_COMMANDS=1
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/settings_reset -- -DSHIELD=settings_reset
Add nibble keymap and config
2021-01-19 03:14:14 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano_v2 -d /workspaces/zmk/app/build/nibble/nnv2 -- -DSHIELD=nibble -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
west build --board nice_nano_v2 -d /workspaces/zmk/app/build/nibble/nnv1 -- -DSHIELD=nibble -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Cleanup tg4x keymap ; set lily underglow led strip length ; tweak notes/readme
2021-01-02 04:58:58 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano_v2 -d /workspaces/zmk/app/build/tidbit -- -DSHIELD=tidbit -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Tweak readme
2021-04-24 00:29:03 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/the_paintbrush_left -- -DSHIELD=the_paintbrush_left -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Bring up artsey on corne left side
2021-02-09 04:51:20 +00:00
tweak build note for latest way of building the paintbrush zmk-ardux stuff
2022-06-11 12:28:22 +00:00
west build --board nice_nano_v2 -d /workspaces/zmk/app/build/the_paintbrush_left_nn_v2 -- -DSHIELD=the_paintbrush_left -DZMK_CONFIG=/workspaces/zmk-ardux/config
misc update
2021-11-19 18:26:35 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/the_paintbrush_right -- -DSHIELD=the_paintbrush_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Add corne artsey right setup
2021-02-14 00:44:58 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano_v2 -d /workspaces/zmk/app/build/the_paintbrush_right_nn_v2 -- -DSHIELD=the_paintbrush_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/corne_5_col_artsey_left_big -- -DSHIELD=corne_5_col_artsey_left_big -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
west build --board nice_nano -d /workspaces/zmk/app/build/corne_5_col_artsey_right_big -- -DSHIELD=corne_5_col_artsey_right_big -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Cleanup tg4x keymap ; set lily underglow led strip length ; tweak notes/readme
2021-01-02 04:58:58 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nrf52840_mdk_dongle -d build/pockettype/central -- -DSHIELD=pockettype_central -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Update notes ; prep tg4x bring up
2020-12-26 21:33:37 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nice_nano -d build/pockettype/peripheral -- -DSHIELD=pockettype_peripheral -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Update notes ; prep tg4x bring up
2020-12-26 21:33:37 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nice_nano -d build/tg4x -- -DSHIELD=tg4x -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Bring up artsey on corne left side
2021-02-09 04:51:20 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/7skb_left -- -DSHIELD=7skb_left -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Tweak readme
2021-04-24 00:29:03 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/7skb_right -- -DSHIELD=7skb_right -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Tweak readme
2021-04-24 00:29:03 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano -d build/miryoku/corne_left -- -DSHIELD=corne_left -DZMK_CONFIG=/workspaces/miryoku/config
Add corne artsey right setup
2021-02-14 00:44:58 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano -d build/miryoku/corne_right -- -DSHIELD=corne_right -DZMK_CONFIG=/workspaces/miryoku/config
Initial bring up of artsey on a tidbit for left handed use
2021-02-07 21:17:12 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Add notes re lily58pro
2020-12-19 22:34:40 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nrf52840_mdk_dongle -d build/mdk_dongle -- -DSHIELD=mdk_dongle -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Update readme for upcoming new builds
2021-02-06 02:16:48 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Add notes re lily58pro
2020-12-19 22:34:40 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano_v2 -d /workspaces/zmk/app/build//tidbit_artsey_left -- -DSHIELD=tidbit_artsey_left -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Add artsey build for tidbit tests
2021-03-13 19:36:51 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build//tidbit_artsey_right -- -DSHIELD=tidbit_artsey_right -DZMK_CONFIG=/workspaces/zmk-config/zmk-artsey/config
Add artsey build for tidbit tests
2021-03-13 19:36:51 +00:00
Update readme commands
2021-07-17 00:27:56 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/navi10 -- -DSHIELD=navi10 -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/corne_left -- -DSHIELD=corne_left -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
west build --board nice_nano -d /workspaces/zmk/app/build/corne_right -- -DSHIELD=corne_right -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
west build --board nice_nano -d /workspaces/zmk/app/build/lily58_left -- -DSHIELD=lily58_left -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
Add makerdiary m60 setup, keymap, notes
2021-01-05 08:18:21 +00:00
misc update
2021-11-19 18:26:35 +00:00
west build --board nice_nano -d /workspaces/zmk/app/build/lily58_right -- -DSHIELD=lily58_right -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
re-order build commands based on how frequently used
2021-02-02 05:09:26 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board itsybitsy_nrf52840 -d build/azarashi64/left -- -DSHIELD=azarashi64_left -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
re-order build commands based on how frequently used
2021-02-02 05:09:26 +00:00
Cleanup and organization
2021-03-13 19:35:46 +00:00
west build --board itsybitsy_nrf52840 -d build/azarashi64/right -- -DSHIELD=azarashi64_right -DZMK_CONFIG=/workspaces/zmk-config/kemonine/zmk-config/config
organize notes
2020-12-20 21:02:10 +00:00
Update personal tidbit config for zmk
2020-12-04 22:43:05 +00:00
```
Reference in a new issue Copy permalink