summaryrefslogtreecommitdiff
path: root/app/boards/shields/nibble/README.md
blob: 42646f97099482b81eab0b21730af280b3a73e0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
```