23839b8c6d
* Clarify the license for files we have signoff on * Update against the currently signed off files * Remove unused and not clearly licensed headers * Replace an #endif I accidentally removed while resolving merge conflicts |
||
|---|---|---|
| .. | ||
| keymaps/default | ||
| Makefile | ||
| config.h | ||
| readme.md | ||
| rules.mk | ||
| template.c | ||
| template.h | ||
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.