zmk/app/boards/shields/tidbit
Joel Spadin 32ae776c42 refactor: Add more checks to pre-commit
Updated existing pre-commit hooks and added some new hooks:

- Remove trailing whitespace
- Ensure every non-empty file ends with a new line
- Check YAML file validity
- Prevent adding large files
- Ensure any scripts with shebangs are executable

Added a GitHub action to run pre-commit on every commit. Removed any
existing actions which duplicate pre-commit.

Ran pre-commit on the codebase.
2023-04-24 16:07:04 -07:00
..
boards fix(underglow): Move to spi3 for underglow bus. 2023-04-09 14:41:00 -07:00
Kconfig.defconfig refactor(display): Updates for LVGL v8.x changes. 2023-04-05 22:55:38 -07: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 fix(display): Add zephyr,display chosen nodes. 2022-04-03 00:10:29 -04:00
tidbit.keymap refactor: Add more checks to pre-commit 2023-04-24 16:07:04 -07:00
tidbit.overlay feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit.zmk.yml refactor(shields): Add pro-micro shield metadata. 2021-09-11 00:50:36 -04:00
tidbit_19key.conf feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
tidbit_19key.keymap refactor: Add more checks to pre-commit 2023-04-24 16:07:04 -07:00
tidbit_19key.overlay feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00

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