diff options
| author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-03-28 11:29:54 -0400 |
|---|---|---|
| committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-03-28 11:29:54 -0400 |
| commit | 95a88c09e18a7531a64838ceaa52df37bad8dc0d (patch) | |
| tree | e108b87cbe318ff4824509be19209b010101d419 /keyboard/retro_refit/README.md | |
| parent | a4ff9f256738cf637553e7840d53f778d791fb6f (diff) | |
| parent | 80eefb09ac5de95a6977702b4014d4b4d79a5d7d (diff) | |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboard/retro_refit/README.md')
| -rw-r--r-- | keyboard/retro_refit/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/retro_refit/README.md b/keyboard/retro_refit/README.md new file mode 100644 index 0000000000..d3c9d4197d --- /dev/null +++ b/keyboard/retro_refit/README.md @@ -0,0 +1,24 @@ +retro_refit keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent README.md](/README.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboard/retro_refit 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 file named `<name>.c` and see keymap document (you can find in top README.md) and existent 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 **__\<name\>.c__** and are stored in the `keymaps` folder.
\ No newline at end of file |