History

IBNobody 1d13aa933b Minor Tweaks and Documentation Fixed compiler warning by including bootloader.h in keymap_common.c. Changed FORCE_NKRO to only be applied if NKRO_ENABLE is defined. Added extra documentation to the template config.h		2016-03-28 19:45:20 -05:00
..
keymaps	missing file	2016-01-29 23:11:25 -05:00
config.h	Minor Tweaks and Documentation	2016-03-28 19:45:20 -05:00
Makefile	Magic Key Overrides / Keyboard Lock / Forced NKRO	2016-03-28 00:03:21 -05:00
README.md	README changes	2016-02-07 10:41:00 -05:00
template.c	Fixed extra semicolons.	2016-03-22 21:06:22 -05:00
template.h	Merge remote-tracking branch 'refs/remotes/jackhumbert/master'	2016-03-22 20:39:05 -05: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 keyboard/%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 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.