zmk_mf68/app/boards/shields/tidbit
innovaker 842aa5a842 refactor: replace filename hyphens with underscores
Aligns *.h and *.c to underscore naming convention.

These were kept (with warnings) for backwards compatibility with external boards/shields:
- kscan-mock.h
- matrix-transform.h
They should be removed in the future.

PR: #523
2020-12-28 01:15:35 -05:00
..
boards feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
Kconfig.defconfig feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
Kconfig.shield feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
README.md feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit.conf feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit.dtsi refactor: replace filename hyphens with underscores 2020-12-28 01:15:35 -05:00
tidbit.keymap feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit.overlay feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit_19key.conf feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit_19key.keymap feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit_19key.overlay feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00

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