History

honorless 6b547019c2 refactor: use zmk,matrix-transform instead of zmk,matrix_transform * Align codebase with documentation.		2024-01-23 23:02:35 -06:00
..
boards	refactor: Remove unimportant labels	2023-12-04 20:06:54 -06:00
Kconfig.defconfig	fix(usb): Tweak how ZMK_USB gets enabled.	2023-11-13 12:56:23 -08:00
Kconfig.shield	refactor: Replace tabs with spaces	2023-04-24 16:07:04 -07:00
nibble.conf	Refactor nibble / update to match build docs (#620 )	2021-02-04 10:28:02 -06:00
nibble.keymap	refactor(keymaps): Rename layer label to "display-name"	2023-12-04 20:06:54 -06:00
nibble.overlay	refactor: use zmk,matrix-transform instead of zmk,matrix_transform	2024-01-23 23:02:35 -06:00
nibble.zmk.yml	refactor(shields): Add pro-micro shield metadata.	2021-09-11 00:50:36 -04:00
README.md	Refactor nibble / update to match build docs (#620 )	2021-02-04 10:28:02 -06:00

README.md

Building ZMK for the Nibble

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

LED Notes

If you built your nibble without the LEDs and are using a nice!nano board, you'll need to change the following in your local nibble 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 nibble without an encoder, you'll need to change the following in your local nibble 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 nibble config or add them to the end of the file.

CONFIG_ZMK_DISPLAY=y