0499e7e8ac
* feat(nibble): add underglow support for nice_nano builds * feat(nibble): add encoder to top, left most column to match standard assembly documentation * refactor(nibble): add layer labels * feat(nibble): add support for optional display ; off by default * feat(nibble): add README * fix(nibble): adjust oled rotation for easier reading * fix(nibble): add additional note about enabling oled * refactor(nibble): convert keymap to use tabs instead of spaces * refactor(nibble): enable oled in dts/overlay by default * refactor(nibble): cleanup alignment and formatting in nibble keymap * refactor(nibble): re-align top most row of keymap to be sensible * refactor(nibble): cleanup kscan map alignment * refactor(nibble): indent first row of map/transform to properly align with physical columns * fix(nibble): remove dangling code block from readme Co-authored-by: KemoNine <mcrosson@kemonine.info>
30 lines
774 B
Markdown
30 lines
774 B
Markdown
# 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
|
|
```
|