qmk_firmware/quantum/template/README.md

24 lines
1 KiB
Markdown
Raw Normal View History

2015-10-27 19:33:18 +01:00
%KEYBOARD% keyboard firmware
======================
## Quantum MK Firmware
2016-02-07 16:41:00 +01:00
For the full Quantum feature list, see [the parent README.md](/README.md).
2015-10-30 05:48:17 +01:00
## Building
2016-02-07 16:41:00 +01:00
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.
2015-10-30 05:48:17 +01:00
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`.
2015-10-27 19:33:18 +01:00
2015-10-30 05:48:17 +01:00
### Other Keymaps
2016-01-24 02:45:52 +01:00
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.
2015-10-27 19:33:18 +01:00
2015-10-30 05:48:17 +01:00
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
2015-10-27 19:33:18 +01:00
```
$ make KEYMAP=[default|jack|<name>]
```
2016-01-24 02:45:52 +01:00
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.