feat(nibble): add README
This commit is contained in:
parent
d52474c7e4
commit
05973c6a88
1 changed files with 29 additions and 0 deletions
29
app/boards/shields/nibble/README.md
Normal file
29
app/boards/shields/nibble/README.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
# 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
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue