aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/kc60/keymaps/ws2812/readme.md
diff options
context:
space:
mode:
authorChristopher Browne <cbbrowne@ca.afilias.info>2016-06-24 12:19:34 -0400
committerChristopher Browne <cbbrowne@ca.afilias.info>2016-06-24 12:19:34 -0400
commit4d79e224384464c8b42c770b3da09b9655d359e7 (patch)
tree7d14e742352d2237ab19fe49985bbacef47d7e6d /keyboards/kc60/keymaps/ws2812/readme.md
parenta4bdb0ac0e6d44c9c9a2d8910a5ca5b7fb49fcbf (diff)
parent40bfc7231e87c883c840967fdbe42a7c711805be (diff)
downloadfirmware-4d79e224384464c8b42c770b3da09b9655d359e7.tar.gz
firmware-4d79e224384464c8b42c770b3da09b9655d359e7.tar.bz2
firmware-4d79e224384464c8b42c770b3da09b9655d359e7.zip
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/kc60/keymaps/ws2812/readme.md')
-rw-r--r--keyboards/kc60/keymaps/ws2812/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/kc60/keymaps/ws2812/readme.md b/keyboards/kc60/keymaps/ws2812/readme.md
new file mode 100644
index 000000000..5588fd2d9
--- /dev/null
+++ b/keyboards/kc60/keymaps/ws2812/readme.md
@@ -0,0 +1,21 @@
+KC60 with WS2812 RGB Underglow
+======================
+
+![Image of KC60 with RGB Underglow](ws2812_example.jpg)
+
+## Quantum MK Firmware
+For the full Quantum feature list, see [the parent readme.md](/readme.md).
+
+## WS2812 Support
+By default, it is now setup for 16 LEDs on the PF5 breakout pin. See [included image](ws2812_wiring.jpg) for wiring reference.
+
+### Build
+To build this keymap with WS2812 enabled, simply run `make KEYMAP=ws2812`.
+
+### Reference Images
+![Wiring Reference](ws2812_wiring.jpg)
+![RGB Strip turned on](ws2812_underside-lit.jpg)
+![RGB Strip turned off](ws2812_underside.jpg)
+
+### Additional Credits
+Keymap based on work by [TerryMatthews](https://github.com/TerryMathews) for GH60 Satan.