zmk/app/boards/shields/tidbit
Peter Johanson 35a1c5a3d4 refactor(behaviors): Rename `reset` behavior.
* Upstream now has a node w/ label `reset` on many boards, so
  renaming our reset behavior node label to `sys_reset`.
2023-04-05 22:55:38 -07:00
..
boards
Kconfig.defconfig refactor(display): Updates for LVGL v8.x changes. 2023-04-05 22:55:38 -07:00
Kconfig.shield
README.md
tidbit.conf
tidbit.dtsi
tidbit.keymap refactor(behaviors): Rename `reset` behavior. 2023-04-05 22:55:38 -07:00
tidbit.overlay
tidbit.zmk.yml
tidbit_19key.conf
tidbit_19key.keymap refactor(behaviors): Rename `reset` behavior. 2023-04-05 22:55:38 -07:00
tidbit_19key.overlay

README.md

Building ZMK for the Tidbit

Some general notes/commands for building standard tidbit layouts from the assembly documentation.

Standard "Non Dense" Build

west build -p -d build/tidbit/default --board nice_nano -- -DSHIELD=tidbit

Dense "19 keys" Build

west build -p -d build/tidbit/19_key --board nice_nano -- -DSHIELD=tidbit_19key

LED Notes

If you built your tidbit without the LEDs and are using a nice!nano board, you'll need to change the following in your local tidbit config or add them to the end of the file.

CONFIG_ZMK_RGB_UNDERGLOW=n
CONFIG_WS2812_STRIP=n

Encoder Notes

If you built your tidbit without encoders, you'll need to change the following in your local tidbit config or add them to the end of the file.

CONFIG_EC11=n
CONFIG_EC11_TRIGGER_GLOBAL_THREAD=n

OLED Builds

If using an OLED screen, you'll need to change the following in your local tidbit config or add them to the end of the file.

CONFIG_ZMK_DISPLAY=y