History

Jack Humbert 338edcabd7 Merge pull request #1184 from osamuaoki/master Update keymap.md to QMK		2017-03-30 08:45:56 -04:00
..
keymaps/default	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07:00
config.h	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07:00
Makefile	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07: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	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07:00
template.h	Merge pull request #1184 from osamuaoki/master	2017-03-30 08:45:56 -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.