summaryrefslogtreecommitdiff
path: root/keyboard/kc60_v2/README.md
diff options
context:
space:
mode:
authorSamuel Goodwin <samuel.goodwin@me.com>2016-05-29 19:18:01 +0200
committerJack Humbert <jack.humb@gmail.com>2016-05-29 13:18:01 -0400
commit478a18d23797e3c6bd9d55732a963fc65db647d9 (patch)
treede07ab84314d5d8a8e731181a967962ea0c34d04 /keyboard/kc60_v2/README.md
parentb85dd60397e139f787ae26552145391f34686f4d (diff)
Add support for the KC60 v2.0 2015-09-12 (#360)
* Don't save the ctags file in the repo. * Initial support for the KC60 board. Only 5x5 working so far. * Rename because this isn't the same KC60 as others. * Add in some generic layout. Pins seem to be in the right order except the 6th column spews gibberish. * Don't need this for now. * Move this to some other folder. * Trying again to start over. * Don't need to start over because I figured out why the 'broken' stuff wasn't working. * Attempt to enable backlighting. It's on on pin B7 like other boards. * Fix last port changes and fix LED control in keymap. * Trying some other LED code. * Bootloader needs to be bigger. Disabling backlight for now. * Simplify LED code while I try to figure it out. * Turn back on backlighting. * Backlighting works now. Just need to get levels or breathing working. * Trying to allow for turning off the LEDs before I get to brightness levels. * The missing link: need to run the init_ports function for LEDs to work properly. * Removing breathing stuff since it bricks the board. * Clean up default layer. * Cleanup keymap, KC60 doesn't support a 5th right bottom-row button.
Diffstat (limited to 'keyboard/kc60_v2/README.md')
-rw-r--r--keyboard/kc60_v2/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/kc60_v2/README.md b/keyboard/kc60_v2/README.md
new file mode 100644
index 0000000000..4be448d15c
--- /dev/null
+++ b/keyboard/kc60_v2/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.