qmk-keychron-q3-colemak-dh/keyboards/kitten_paw/readme.md
René Werner a26ee57eb8 Added support for the Kitten Paw controller
This adds support for the 2016 revision of the Kitten Paw [1] replacement
controller by Bathroom Epiphanies.

[1] http://bathroomepiphanies.com/controllers/
2016-08-22 20:34:29 +02:00

1.4 KiB

kitten_paw keyboard firmware

This is the firmware for the 2016 revision of the Kitten Paw controller by Bathroom Epiphanies. Most of the boilerplate code is the work of BathroomEpiphanies.

NKRO doesn't work at the moment, I don't know if I will take the time to find out how to fix this, so far 6KRO is enough for me.

Quantum MK Firmware

For the full Quantum feature list, see the parent readme.md.

Building

Download or clone the whole firmware and navigate to the keyboards/kitten_paw 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 a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant 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 keymap.c and are stored in folders in the keymaps folder, eg keymaps/my_keymap/