diff options
author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-22 11:26:26 -0400 |
---|---|---|
committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-22 11:26:26 -0400 |
commit | b0caf32741cf415a45333828f1661d9f6b72570f (patch) | |
tree | 5e2b8203ab232c0a89264e96716ebf1a859f6189 /keyboards/kc60/README.md | |
parent | ee3c7892ad585e2e702d8975420d25ae052d97bb (diff) | |
parent | 8c1bfdf0bd9aae13d8722fd107deca40ffc7932c (diff) |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/kc60/README.md')
-rw-r--r-- | keyboards/kc60/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/kc60/README.md b/keyboards/kc60/README.md new file mode 100644 index 0000000000..1f03e200e4 --- /dev/null +++ b/keyboards/kc60/README.md @@ -0,0 +1,27 @@ +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 keyboards/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. + +### Default +To build with the default keymap, simply run `make`. + +### Other Keymaps +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files. + +To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: +``` +$ 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`. |