qmk_firmware/quantum/template/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.
new project script 2015-10-27 18:33:18 +00:00			`%KEYBOARD% keyboard firmware`
			`======================`

			`## Quantum MK Firmware`

Fix the keyboard template with new make syntax Also add proper link to the parent 2016-08-27 20:29:37 +00:00			`For the full Quantum feature list, see [the parent readme](/).`
atomic up-to-date 2015-10-30 04:48:17 +00:00
			`## Building`

Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) * fixes from tmk's repo * rename keyboard to keyboards 2016-06-22 02:39:54 +00:00			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.
atomic up-to-date 2015-10-30 04:48:17 +00:00
			`Depending on which keymap you would like to use, you will have to compile slightly differently.`

			`### Default`
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00
Fix the keyboard template with new make syntax Also add proper link to the parent 2016-08-27 20:29:37 +00:00			To build with the default keymap, simply run `make default`.
new project script 2015-10-27 18:33:18 +00:00
atomic up-to-date 2015-10-30 04:48:17 +00:00			`### Other Keymaps`
new project script 2015-10-27 18:33:18 +00:00
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00: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 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.`

Fix the keyboard template with new make syntax Also add proper link to the parent 2016-08-27 20:29:37 +00:00			To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00
new project script 2015-10-27 18:33:18 +00:00			```
Fix the keyboard template with new make syntax Also add proper link to the parent 2016-08-27 20:29:37 +00:00			`$ make [default\|jack\|<name>]`
new project script 2015-10-27 18:33:18 +00:00			```
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00
Fix the keyboard template with new make syntax Also add proper link to the parent 2016-08-27 20:29:37 +00:00			Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.