Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware

[qmk_firmware.git] / keyboards / ergodox / readme.md

diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index 304f2b01f2db6c33359cb5cfbf8735fcec5e6aea..3bbe98fd699b1532d182e0f9fca88ca88d09ac3a 100644 (file)
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -1,3 +1,16 @@
+# The Easy Way
+
+If you can find firmware someone else has made that does what you want, that
+is the easiest way to customize your ErgoDox.  It requires no programming
+experience or the setup of a build environment.
+
+Quickstart:
+
+  - Find and download an existing firmware
+    [from Other Firmware Options](#other-firmware-options)
+
+  - Then flash the firmware to your [ErgoDox Ez](#ergodox-ez)
+    or [ErgoDox Infinity](#ergodox-infinity)
 
 # Customizing Keymaps
 
@@ -59,9 +72,7 @@ Some distributions provide a binary, maybe called `teensy-loader-cli`).
 
 To flash the firmware:
 
-  - Build the firmware with `make keymap=keymapname`, for example `make
-    keymap=default`
-
+  - Build the firmware with `make keymapname`, for example `make default` 
   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
     `ergodox_ez_default.hex`
 
@@ -79,25 +90,47 @@ To flash the firmware:
 The Infinity is two completely independent keyboards, and needs to be flashed
 for the left and right halves seperately.  To flash them:
 
-  - Build the firmware with `make keymap=keymapname subproject=infinity`
+  - Build the firmware with `make infinity-keymapname`
 
   - Plug in the left hand keyboard only.
 
   - Press the program button (back of keyboard, above thumb pad).
 
-  - Install the firmware with `sudo make dfu-util keymap=keymapname subproject=infinity`
+  - Install the firmware with `sudo make infinity-keymapname-dfu-util`
 
-  - Build left hand firmware with `make keymap=keymapname subproject=infinity MASTER=right`
+  - Build left hand firmware with `make infinity-keymapname MASTER=right`
 
   - Plug in the right hand keyboard only.
 
   - Press the program button (back of keyboard, above thumb pad).
 
-  - Install the firmware with `sudo make dfu-util keymap=keymapname subproject=infinity MASTER=right`
+  - Install the firmware with `sudo make infinity-keymapname-dfu-util MASTER=right`
 
 More information on the Infinity firmware is available in the [TMK/chibios for
 Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
 
+### Infinity Master/Two Halves
+
+The Infinity is two completely independent keyboards, that can connect together.
+You have a few options in how you flash the firmware:
+
+- Flash the left half, rebuild the firmware with "MASTER=right" and then flash
+  the right half.  This allows you to plug in either half directly to the
+  computer and is what the above instructions do.
+
+- Flash the left half, then flash the same firmware on the right.  This only
+  works when the left half is plugged directly to the computer and the keymap
+  is mirrored.  It saves the small extra step of rebuilding with
+  "MASTER=right".
+
+- The same as the previous one but with "MASTER=right" when you build the
+  firmware, then flash the same firmware to both halves.  You just have to
+  directly connect the right half to the computer.
+
+- For minor changes such as changing only the keymap without having updated
+  any part of the firmware code itself, you can program only the MASTER half.
+  It is safest to program both halves though.
+
 # Contributing your keymap
 
 The QMK firmware is open-source, so it would be wonderful to have your contribution! Within a very short time after launching we already amassed dozens of user-contributed keymaps, with all sorts of creative improvements and tweaks. This is very valuable for people who aren't comfortable coding, but do want to customize their ErgoDox. To make it easy for these people to use your layout, I recommend submitting your PR in the following format.