From 05973c6a88b6d68ab54cb09820aa97e55e12667d Mon Sep 17 00:00:00 2001
From: KemoNine <mcrosson@kemonine.info>
Date: Tue, 19 Jan 2021 00:28:09 +0000
Subject: [PATCH] feat(nibble): add README

---
 app/boards/shields/nibble/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 app/boards/shields/nibble/README.md

diff --git a/app/boards/shields/nibble/README.md b/app/boards/shields/nibble/README.md
new file mode 100644
index 00000000..42646f97
--- /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
+```