History

Gabriel Young d11962aeb2 fix 'stop_all_notes' naming to be more consistent		2017-03-02 11:40:06 -08:00
..
keymaps/default	fix 'stop_all_notes' naming to be more consistent	2017-03-02 11:40:06 -08:00
config.h	Update existing keymaps	2017-02-25 20:41:13 -08:00
Makefile	Fix the template for the Makefile/rules.mk split	2016-08-20 03:56:45 +03:00
readme.md	Fix the keyboard template with new make syntax	2016-08-27 23:31:15 +03:00
rules.mk	Update size estimates in the Makefile	2017-02-25 21:38:35 -08:00
template.c	fixes quantum template (actually)	2016-07-07 12:22:10 -04:00
template.h	Backlight abstraction and other changes (#439 )	2016-06-23 22:18:20 -04:00

readme.md

%KEYBOARD% keyboard firmware

Quantum MK Firmware

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

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

$ make [default|jack|<name>]

Keymaps follow the format <name>.c and are stored in the keymaps folder.