diff options
author | cbbrowne <cbbrowne@cbbrowne.tor.int-afilias.info> | 2016-08-09 18:10:48 +0200 |
---|---|---|
committer | cbbrowne <cbbrowne@cbbrowne.tor.int-afilias.info> | 2016-08-09 18:10:48 +0200 |
commit | 6a618fd44d076ae86d9c2a3414358ae9f3632ba8 (patch) | |
tree | 6d55aa3c18b813f572884a2406027122568ab398 /keyboards/cluecard/readme.md | |
parent | 6ce0195e24bde8ce83976ba7fd2a701e7a1f13d7 (diff) | |
parent | adad05c3fbd511e77a77484945fa2f675d6abf8b (diff) | |
download | qmk_firmware-6a618fd44d076ae86d9c2a3414358ae9f3632ba8.tar.gz qmk_firmware-6a618fd44d076ae86d9c2a3414358ae9f3632ba8.tar.xz |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/cluecard/readme.md')
-rw-r--r-- | keyboards/cluecard/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/cluecard/readme.md b/keyboards/cluecard/readme.md new file mode 100644 index 000000000..ae1afbbfd --- /dev/null +++ b/keyboards/cluecard/readme.md @@ -0,0 +1,28 @@ +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`. + +### 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 `keymap` option like: + +``` +$ make keymap=[default|jack|<name>] +``` + +Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |