diff options
| author | Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
|---|---|---|
| committer | Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
| commit | 57a6828a7a73d7b7c3dd9693e04d6873e2e3d1c2 (patch) | |
| tree | bdabbdbdd9fd6de500728721d1865058468871e3 /keyboards/retro_refit/readme.md | |
| parent | bf2b260429dbc015d49d005065a37441c8f15753 (diff) | |
| parent | 5f9c2f63ffb2c58db73e67442134be58bfe2c129 (diff) | |
Merge branch 'master' of http://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/retro_refit/readme.md')
| -rw-r--r-- | keyboards/retro_refit/readme.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/keyboards/retro_refit/readme.md b/keyboards/retro_refit/readme.md deleted file mode 100644 index b01a1a9ca9..0000000000 --- a/keyboards/retro_refit/readme.md +++ /dev/null @@ -1,24 +0,0 @@ -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 keyboards/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 |