skylark-qmk/keyboards/kc60/readme.md

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 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 a keymap like this:

```
$ 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 ws2812`.
Add sgoodwin keymap for the KC60 (#410) * 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. * Add in the keymap I want for now. * Back to escape by default. * Move my personal keymap to the new place for keymaps. * Add the version number for clarity. 2016-06-14 15:21:55 +00:00			`KC60 (version 2.0) keyboard firmware`
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. 2016-05-29 17:18:01 +00:00			`======================`

			`## Quantum MK Firmware`
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00			`For the full Quantum feature list, see [the parent readme.md](/readme.md).`
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. 2016-05-29 17:18:01 +00:00
			`## Building`
Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) * fixes from tmk's repo * rename keyboard to keyboards 2016-06-22 02:39:54 +00:00			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.
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. 2016-05-29 17:18:01 +00:00
			`Depending on which keymap you would like to use, you will have to compile slightly differently.`

			`### Default`
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			To build with the default keymap, simply run `make default`.
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. 2016-05-29 17:18:01 +00:00
			`### Other Keymaps`
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00			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.
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. 2016-05-29 17:18:01 +00:00
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			To build the firmware binary hex file with a keymap just do `make` with a keymap like this:

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. 2016-05-29 17:18:01 +00:00			```
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			`$ make [default\|jack\|<name>]`
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. 2016-05-29 17:18:01 +00:00			```
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00
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. 2016-05-29 17:18:01 +00:00			Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.
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 2016-06-20 03:29:42 +00:00
			`## WS2812 Support`
			`![Image of KC60 with RGB Underglow](keymaps/ws2812/ws2812_example.jpg)`

Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			Build with WS2812 Support by running `make ws2812`.