summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md')
-rw-r--r--keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md b/keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md
new file mode 100644
index 0000000000..02888855b8
--- /dev/null
+++ b/keyboards/handwired/xeal60/keymaps/OLED_sample/readme.md
@@ -0,0 +1,25 @@
+SSD1306 OLED Display via I2C
+======
+
+Features
+--------
+
+Some features supported by the firmware:
+
+
+* I2C connection between the two halves is required as the OLED display will use this connection as well. Note this
+ requires pull-up resistors on the data and clock lines.
+* OLED display will connect from either side
+
+
+Wiring
+------
+
+
+Work in progress...
+
+
+OLED Configuration
+-------------------------------
+
+Work in progress...