summaryrefslogtreecommitdiff
path: root/keyboards/retro_refit/readme.md
diff options
context:
space:
mode:
authorNathan Sharfi <me@ngalt.com>2016-07-31 14:02:25 -0700
committerNathan Sharfi <me@ngalt.com>2016-07-31 14:02:25 -0700
commitd889648d5373b7ff77dc7bc4b369c628e8336b45 (patch)
tree35c6eb194417242958baf54b36f0ff3a56e378f1 /keyboards/retro_refit/readme.md
parent6428069eb70f5cc47ac1f3f9acf3daea14fb9097 (diff)
parentb25dbc484d639210c53d8e13f79cf5a77f2faaaa (diff)
Merge branch 'master' of github.com:jackhumbert/qmk_firmware
# Conflicts: # keyboard/ergodox_ez/keymaps/zweihander-osx/keymap.c # keyboard/ergodox_ez/keymaps/zweihander-osx/zweihander-osx.hex
Diffstat (limited to 'keyboards/retro_refit/readme.md')
-rw-r--r--keyboards/retro_refit/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/retro_refit/readme.md b/keyboards/retro_refit/readme.md
new file mode 100644
index 0000000000..b01a1a9ca9
--- /dev/null
+++ b/keyboards/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 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