aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Reifschneider <sean@realgo.com>2016-08-24 09:26:41 -0600
committerSean Reifschneider <sean@realgo.com>2016-08-24 09:26:41 -0600
commit7debe7cd777f50ef0adf4d3b4623946232f1eccf (patch)
treeaf26e4db984120e116fa421a682a6c79d14de9a2
parent0418ecc073d420fff3be2603bfb7a6fa234bd357 (diff)
downloadqmk_firmware-7debe7cd777f50ef0adf4d3b4623946232f1eccf.tar.gz
qmk_firmware-7debe7cd777f50ef0adf4d3b4623946232f1eccf.zip
Changes based on @fredizzimo review, flashing Infinity details
-rw-r--r--keyboards/ergodox/readme.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index 304f2b01f..4730de36f 100644
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -1,3 +1,15 @@
1# The Easy Way
2
3If you can find firmware someone else has made that does what you want, that
4is the easiest way to customize your ErgoDox. It requires no programming
5experience or the setup of a build environment.
6
7Quickstart:
8
9 - Find and download an [existing firmware](#other-firmware-options)
10
11 - Then flash the firmware to your [ErgoDox Ez](#ergodox-ez)
12 or [ErgoDox Infinity](#ergodox-infinity)
1 13
2# Customizing Keymaps 14# Customizing Keymaps
3 15
@@ -98,6 +110,28 @@ for the left and right halves seperately. To flash them:
98More information on the Infinity firmware is available in the [TMK/chibios for 110More information on the Infinity firmware is available in the [TMK/chibios for
99Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md) 111Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
100 112
113### Infinity Master/Two Halves
114
115The Infinity is two completely independent keyboards, that can connect together.
116You have a few options in how you flash the firmware:
117
118- Flash the left half, rebuild the firmware with "MASTER=right" and then flash
119 the right half. This allows you to plug in either half directly to the
120 computer and is what the above instructions do.
121
122- Flash the left half, then flash the same firmware on the right. This only
123 works when the left half is plugged directly to the computer and the keymap
124 is mirrored. It saves the small extra step of rebuilding with
125 "MASTER=right".
126
127- The same as the previous one but with "MASTER=right" when you build the
128 firmware, then flash the same firmware to both halves. You just have to
129 directly connect the right half to the computer.
130
131- For minor changes such as changing only the keymap without having updated
132 any part of the firmware code itself, you can program only the MASTER half.
133 It is safest to program both halves though.
134
101# Contributing your keymap 135# Contributing your keymap
102 136
103The 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. 137The 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.