diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-21 22:39:54 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-21 22:39:54 -0400 |
| commit | 649b33d7783cf3021928534b7ae127e0a89e8807 (patch) | |
| tree | c2b5e0cf8ff4aa2918e3b88ab75dbdb071cc0a1d /keyboard/retro_refit/README.md | |
| parent | 464c8e274f993d3571fe5ea5e836fe55a3912ffe (diff) | |
Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432)
* fixes from tmk's repo
* rename keyboard to keyboards
Diffstat (limited to 'keyboard/retro_refit/README.md')
| -rw-r--r-- | keyboard/retro_refit/README.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/keyboard/retro_refit/README.md b/keyboard/retro_refit/README.md deleted file mode 100644 index d3c9d4197d..0000000000 --- a/keyboard/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 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 |