diff options
| author | Joshua T <joshua@sonofone.net> | 2016-10-15 15:14:10 -0500 |
|---|---|---|
| committer | Joshua T <joshua@sonofone.net> | 2016-10-15 15:14:10 -0500 |
| commit | 2e6a1a53d73607030c470b88d3ed7223db5e0004 (patch) | |
| tree | fd8ff310f0dba21f9135cdead49482af2276329b /keyboards/retro_refit/readme.md | |
| parent | 5520b0022fc6cd3dff805eb31ed4bb7e4385ee2a (diff) | |
| parent | 0a9ad8f335f5b5b9d184d9e5e9ece6cda149df7e (diff) | |
Merge remote-tracking branch 'upstream/master'
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 77df861cef..0000000000 --- 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 |