diff options
Diffstat (limited to 'keyboard/kc60/keymaps/ws2812/README.md')
-rw-r--r-- | keyboard/kc60/keymaps/ws2812/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboard/kc60/keymaps/ws2812/README.md b/keyboard/kc60/keymaps/ws2812/README.md new file mode 100644 index 0000000000..af76f7ab18 --- /dev/null +++ b/keyboard/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. |