diff options
author | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
---|---|---|
committer | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
commit | b49d7800aeae1009b39b2bff2121864425e73ce9 (patch) | |
tree | f73447fc32940c7bc6b691a83567186d1afbc991 /keyboards/kc60/readme.md | |
parent | 9ecf9073b96799e52a1f1c0d35b57177382902ce (diff) | |
parent | ae95834f5af7404c04e6fe3446019046278d814b (diff) | |
download | qmk_firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.tar.gz qmk_firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.zip |
Merge remote-tracking branch 'refs/remotes/jackhumbert/master'
Diffstat (limited to 'keyboards/kc60/readme.md')
-rw-r--r-- | keyboards/kc60/readme.md | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/keyboards/kc60/readme.md b/keyboards/kc60/readme.md index acc0df68dc..da84f6159a 100644 --- a/keyboards/kc60/readme.md +++ b/keyboards/kc60/readme.md @@ -10,18 +10,27 @@ Download or clone the whole firmware and navigate to the keyboards/kc60 folder. 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`. +To build with the default keymap, simply run `make default`. ### 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: +To build the firmware binary hex file with a keymap just do `make` with a keymap like this: + ``` -$ make KEYMAP=[default|jack|<name>] +$ make [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`. +Build with WS2812 Support by running `make ws2812`. + +## Warning +For those who want to use 2x1U instead of classic backspace you need to use K0D and K49 like this: +* K0D represents the key at the right of =. +* K49 represents the last key of the row (is wired at the right of the space key on the PCB) + +In kc60.h I've put several definitions' examples of possible layouts proposed by online editor (http://123.57.250.164:9128/). |