diff options
author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-13 16:06:03 -0400 |
---|---|---|
committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-13 16:06:03 -0400 |
commit | dc9bf78f2b1d7d894576d87ea9bfc86d7bb3deee (patch) | |
tree | 44f432118882f9176ef6d901dc3d389d28737254 /keyboard/kc60/README.md | |
parent | d649ab34334ff568448c47a04fcf40f1aa960135 (diff) | |
parent | 25d4772754186b8ab6ef86c28049da67a460f123 (diff) |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboard/kc60/README.md')
-rw-r--r-- | keyboard/kc60/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/kc60/README.md b/keyboard/kc60/README.md new file mode 100644 index 0000000000..4be448d15c --- /dev/null +++ b/keyboard/kc60/README.md @@ -0,0 +1,24 @@ +kc60 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. + +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. |