[jackhill/qmk/firmware.git] / keyboards / cluecard / readme.md

cluecard keyboard firmware
======================

## Quantum MK Firmware

For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).

## Building

Download or clone the whole firmware and navigate to the keyboards/cluecard 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 **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
Commit	Line	Data
adad05c3	1	cluecard keyboard firmware
	2	======================
	3
	4	## Quantum MK Firmware
	5
	6	For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
	7
	8	## Building
	9
	10	Download or clone the whole firmware and navigate to the keyboards/cluecard 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.
	11
	12	Depending on which keymap you would like to use, you will have to compile slightly differently.
	13
	14	### Default
	15
da226e61	16	To build with the default keymap, simply run `make default`.
adad05c3	17
	18	### Other Keymaps
	19
	20	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.
	21
da226e61	22	To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
adad05c3	23
adad05c3	24	```
da226e61	25	$ make [default\|jack\|<name>]
adad05c3	26	```
	27
	28	Keymaps follow the format __keymap.c__ and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`