summaryrefslogtreecommitdiff
path: root/keyboard/kc60/README.md
diff options
context:
space:
mode:
authorStanley Lai <stanleylai.sg@gmail.com>2016-06-19 20:29:42 -0700
committerJack Humbert <jack.humb@gmail.com>2016-06-19 23:29:42 -0400
commit3302258abd8929e03c9af71393afc5c9d6947c23 (patch)
tree64d43847617faf94f3e76055062ead63a972264c /keyboard/kc60/README.md
parent3f6fac4721c0f03dab7704b09329d720c85470ce (diff)
downloadqmk_firmware-3302258abd8929e03c9af71393afc5c9d6947c23.tar.gz
qmk_firmware-3302258abd8929e03c9af71393afc5c9d6947c23.zip
Added WS2812 support for KC60 (#419)
* Added WS2812 support for KC60 * Reorganized WS2812 support into its own keymap * Fixed relative link in README * Moved WS2812 mention in README to the bottom * Fixed titling in WS2812 README * Reverted KC60 Makefile and default keymap back * Moved RGB specific config.h to ws2812 keymap folder
Diffstat (limited to 'keyboard/kc60/README.md')
-rw-r--r--keyboard/kc60/README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/keyboard/kc60/README.md b/keyboard/kc60/README.md
index fbc5ac9422..00d78d0a6b 100644
--- a/keyboard/kc60/README.md
+++ b/keyboard/kc60/README.md
@@ -2,12 +2,10 @@ KC60 (version 2.0) keyboard firmware
======================
## Quantum MK Firmware
-
For the full Quantum feature list, see [the parent README.md](/README.md).
## Building
-
-Download or clone the whole firmware and navigate to the keyboard/kc60 folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
+Download or clone the whole firmware and navigate to the keyboard/kc60 folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
Depending on which keymap you would like to use, you will have to compile slightly differently.
@@ -22,3 +20,8 @@ To build the firmware binary hex file with a keymap just do `make` with `KEYMAP`
$ make KEYMAP=[default|jack|<name>]
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
+
+## WS2812 Support
+![Image of KC60 with RGB Underglow](keymaps/ws2812/ws2812_example.jpg)
+
+Build with WS2812 Support by running `make KEYMAP=ws2812`.