You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/quantum/template
Jack Humbert db32864ce7
Cleans up quantum/keymap situation, removes extra lufa folders (#416)
9 years ago
..
keymaps/default Makefile redo & other features (#395) 9 years ago
Makefile Makefile redo & other features (#395) 9 years ago
README.md Makefile redo & other features (#395) 9 years ago
config.h Optimize matrix scanning (#343) 9 years ago
template.c Leader key implementation (#326) 9 years ago
template.h Cleans up quantum/keymap situation, removes extra lufa folders (#416) 9 years ago

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 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.