diff options
| author | Damien <Dbroqua@users.noreply.github.com> | 2016-09-19 13:25:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-19 13:25:37 +0200 |
| commit | c438a2a265b366c8e4594ce561feb896018983f0 (patch) | |
| tree | f310e72223a25414f69c2dec70509fed26dc3960 /keyboards/retro_refit/readme.md | |
| parent | af24ea558a65fea549bd9f57a9704b904972d2f7 (diff) | |
| parent | 5f9c2f63ffb2c58db73e67442134be58bfe2c129 (diff) | |
| download | qmk_firmware-c438a2a265b366c8e4594ce561feb896018983f0.tar.gz qmk_firmware-c438a2a265b366c8e4594ce561feb896018983f0.tar.xz | |
Merge pull request #4 from jackhumbert/master
Merge from jackhumbert
Diffstat (limited to 'keyboards/retro_refit/readme.md')
| -rw-r--r-- | keyboards/retro_refit/readme.md | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/keyboards/retro_refit/readme.md b/keyboards/retro_refit/readme.md deleted file mode 100644 index 77df861ce..000000000 --- a/keyboards/retro_refit/readme.md +++ /dev/null @@ -1,26 +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 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 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 a keymap like this: - -``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
\ No newline at end of file |