Set pinout and layout

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

diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index 4730de36f603a2da6eb1b9f510baf3b68c09bbb5..45b3354c1c88b309cf62edea9311c51a7ce7fcab 100644 (file)
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -1,12 +1,15 @@
 # The Easy Way
 
+If you have an ErgoDox EZ, the absolute easiest way for you to customize your firmware is using the [graphical configurator](http://configure.ergodox-ez.com), which uses QMK under the hood. 
+
 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](#other-firmware-options)
+  - 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)
@@ -22,7 +25,7 @@ If none of the existing keymaps suit you, you can create your own custom
 keymap.  This will require some experience with coding.  Follow these steps
 to customize a keymap:
 
-  - Read the [qmk firmware README](https://github.com/jackhumbert/qmk_firmware) from top to bottom.  Then come back here.  :)
+  - Read the [qmk firmware README](https://github.com/qmk/qmk_firmware) from top to bottom.  Then come back here.  :)
 
   - Clone the qmk_firmware repository
 
@@ -62,7 +65,7 @@ files.  Check them out with:
 
 # Flashing Firmware
 
-## ErgoDox Ez
+## ErgoDox EZ
 
 The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
 
@@ -71,9 +74,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`
 
@@ -91,21 +92,21 @@ 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)
@@ -154,13 +155,10 @@ If you want to send a plain vanilla key, you can look up its code under `doc/key
 There are external tools for customizing the layout, but those do not use
 the featurs of this qmk firmware.  These sites include:
 
-  - [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) for Ez
+  - The official [ErgoDox EZ configurator](http://configure.ergodox-ez.com)
+  - [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) for EZ, works but not officially supported
   - [Input Club configurator](https://input.club/configurator-ergodox) for Infinity, provides left and right files
 
 You can also find an existing firmware that you like, for example from:
 
   - [Dozens of community-contributed keymaps](http://qmk.fm/keyboards/ergodox/)
-
-This qmk firmware also provides the ability to customize keymaps, but requires
-a toolchain to build the firmware.  See below for instructions on building
-firmware and customizing keymaps.