summaryrefslogtreecommitdiff
path: root/app/boards/shields/nibble/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'app/boards/shields/nibble/README.md')
-rw-r--r--app/boards/shields/nibble/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/app/boards/shields/nibble/README.md b/app/boards/shields/nibble/README.md
new file mode 100644
index 0000000..42646f9
--- /dev/null
+++ b/app/boards/shields/nibble/README.md
@@ -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
+```