History

Jack Humbert 649b33d778 Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432 ) * fixes from tmk's repo * rename keyboard to keyboards		2016-06-21 22:39:54 -04:00
..
keymaps/default	Makefile redo & other features (#395 )	2016-06-11 13:31:31 -04:00
config.h	Optimize matrix scanning (#343 )	2016-05-23 23:42:21 -04:00
Makefile	updates all config.h and Makefiles to correct references, text	2016-06-21 10:21:43 -04:00
README.md	Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432 )	2016-06-21 22:39:54 -04:00
template.c	Leader key implementation (#326 )	2016-05-15 00:27:32 -04:00
template.h	Cleans up quantum/keymap situation, removes extra lufa folders (#416 )	2016-06-18 14:30:24 -04:00

README.md

%KEYBOARD% keyboard firmware

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/%KEYBOARD% 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.