2 =======================
4 This is an unconventional layout for the ErgoDox EZ. For more details about the
5 history of the layout, see my
6 [blog posts about my ErgoDox journey][blog-ergodox].
8 [blog-ergodox]: https://asylum.madhouse-project.org/blog/tags/ergodox/
10 Some of the things in the layout only work when one uses Spacemacs and GNOME
11 under Linux. Your mileage may vary.
16 - [Base layer](#base-layer)
17 - [Experimental layer](#experimental-layer)
18 - [Hungarian layer](#hungarian-layer)
19 - [Navigation and media layer](#navigation-and-media-layer)
20 - [One-handed layer](#one-handed-layer)
21 - [Steno layer](#steno-layer)
22 - [LED states](#led-states)
23 * [Building](#building)
24 - [Using on Windows](#using-on-windows)
25 * [Changelog](#changelog)
32 [![Base layer](images/base-layer.png)](http://www.keyboard-layout-editor.com/#/gists/28f7eb305fdbff943613e1dc7aa9e82b)
34 At its core, this is a Dvorak layout, with some minor changes. The more
35 interesting parts are how certain keys behave:
37 * The keys on the number row double as function keys, when held for a bit longer
38 than an usual tap. This allows me to use the function keys without having to
40 * The `Shift`, `Alt`, and `Control` modifiers are one-shot. When tapped, they
41 are considered active for the next key press only. When double tapped, they
42 toggle on, until a third, single tap sometime later. When held, they act as
43 expected. My usual pattern is that I use these for the next keypress only, so
44 this behaviour is perfect. If I need them held, I'll just double-tap.
45 * The `GUI` key is special, because when I double-tap it, it sends `GUI + w`,
46 which pops up an application selector. It also switches to a one-shot layer,
47 where the number row on the left half turns into app selector macros, for the
48 most common things I usually want to switch to. Otherwise it behaves as on a
50 * The `ESC` key also doubles as a one-shot cancel key: if tapped while any of
51 the one-shot modifiers are in-flight (as in, single-tapped, and not expired
52 yet), it cancels all one-shot modifiers. It also cancels the **Hun** layer, if
53 active. Otherwise it sends the usual keycode.
54 * The **Media**, **Arrow**, and **Hun** layer keys are one-shot, the **1Hand**
55 and **STENO** keys are toggles.
56 * Toggling the **Arrow** layer toggles between the cursor arrows and the paging
57 keys on the bottom row.
58 * Tapping the `:` key once yields `:`, tapping it twice yields `;`.
59 * The **Lead** key allows me to type in a sequence of keys, and trigger some
61 - `LEAD u` enters unicode input mode, by sending the GTK+ key sequence that
63 - `LEAD l` uses the unicode input method to enter a `λ`.
64 - `LEAD s` does a lot of magic to type in a shruggie: `¯\_(ツ)_/¯`
65 - `LEAD y` types `\o/`.
66 - `LEAD w m` maximises the currently focused window.
67 - `LEAD e` makes the [experimental layer](#experimental-layer) the default.
68 - `LEAD v` prints the firmware version, the keyboard and the keymap.
72 [![Experimental layer](images/experimental-layer.png)](http://www.keyboard-layout-editor.com/#/gists/6ff50bf71248e05aab5b3fec4fae3d08)
74 While using the standard Dvorak layout, I encountered a number of
75 inconveniences, and on this layer, I am playing with ideas to make the layout
76 feel better. Initially, it was based on [Capewell-Dvorak][cpd], but that too,
77 had shortcomings I was not happy with. So now this is something inbetween, with
78 own observations thrown in. How it works out in the long run remains to be seen.
80 [cpd]: http://www.michaelcapewell.com/projects/keyboard/layout_capewell-dvorak.htm
84 [![Hungarian layer](images/hun-layer.png)](http://www.keyboard-layout-editor.com/#/gists/b160f6ec90d58c127c114c89f66e9dc9)
86 On this layer, the accented characters are at the same position as their base
87 variant. For some, which can have other diatribes, the long one is on top,
88 short's on bottom. Tapping any of the accented characters takes us back to the
91 ## Navigation and media layer
93 [![Navigation and media layer](images/nav-n-media-layer.png)](http://www.keyboard-layout-editor.com/#/gists/c59c453f9fe1a3238ba1494e7e5c6892)
95 This layer is primarily for navigating with the cursor or the mouse, and some
100 [![One-handed layer](images/one-handed-layer.png)](http://www.keyboard-layout-editor.com/#/gists/edff2495135955b8963198dace7f7ece)
102 The one-handed layer is used in situations where the right hand is occupied, by
103 mousing around, for example. Tapping the `OTHER` key switches which side is
104 active. For the most part, keys remain in their usual position. When the right
105 half is active, keys are mirrored to the left half.
107 The differences are as follows:
109 * The `ESC` key has been moved to the bottom row, so the `OTHER` key is easier
111 * Most keys on the thumb cluster now have dual uses, and these do not change
112 when switching sides:
113 - The `Space`/`Backspace` key sends `Space` on tap, `Backspace` when held
114 for longer than a normal tap.
115 - The `Enter`/`Shift` key sends `Enter` on short-tap, `Shift` on long-tap.
116 * The `Apps`/`BASE` key can be used to go back to the base layer, by
117 long-tapping it. A short-tap will send the `App` key, as usual.
121 [![Steno layer for Plover](images/steno-layer.png)](http://www.keyboard-layout-editor.com/#/gists/401ef9a84369e47c57f9aedcf0a0d667)
123 This is to be used with [Plover](http://www.openstenoproject.org/plover/),
124 nothing really fancy here. The **STENO** key toggles the layer on and off, and
125 sends the toggle command to Plover too.
129 The primary purpose of the LEDs is to show the modifier status, a secondary, to
130 show which layer is active. Each modifier, `Shift`, `Alt` and `Control` each
131 have their designated LEDs: the *red*, *green* and *blue*, respectively. When a
132 modifier is in a one-shot state, the respective LED will turn on with a dimmer
133 light. If the modifier is toggled on, the brightness of the LED turns full.
135 For the layers, the following rules apply:
137 * When the [Experimental layer](#experimental-layer) is toggled on, LEDs will
138 light up from left to right in a sequence, then turn off. When the layer is
139 toggled off, the LEDs light up and turn off in the other direction. No LEDs
140 are on while the layer is active.
141 * When the [Hungarian layer](#hungarian-layer) is active, the *green* and *blue*
143 * When the [Navigation and media layer](#navigation-and-media-layer) is active,
144 the *red* and *green* ones are on.
145 * When the [One-handed layer](#one-handed-layer) is active, the *green* LED is
146 on and bright, and either the *red* or the *blue* one is going to slowly
147 blink, depending on the currently active side.
148 * For the [Steno layer](#steno-layer), all LEDs will be turned on.
150 Unless noted otherwise, the layers use a dim light for the LEDs, while modifiers
151 use a stronger one, and modifiers override any layer preferences. For example,
152 when on the one-handed layer, with the left side active (*red* light blinking),
153 if `Shift` is on, the *red* light will be constantly on.
157 To make my workflow easier, this layout is maintained in
158 [its own repository][algernon:ez-layout]. To build it, you will need the
159 [QMK][qmk] firmware checked out, and this repo either checked out to something
160 like `keyboards/ergodox_ez/algernon-master`. One way to achieve that is this:
162 [algernon:ez-layout]: https://github.com/algernon/ergodox-layout
163 [qmk]: https://github.com/jackhumbert/qmk_firmware
166 $ git clone https://github.com/jackhumbert/qmk_firmware.git
168 $ git clone https://github.com/algernon/ergodox-layout.git \
169 keyboards/ergodox_ez/keymaps/algernon-master
170 $ make KEYBOARD=ergodox_ez KEYMAP=algernon-master
173 From time to time, updates may be submitted back to the QMK repository. If you
174 are reading it there, you can build the firmware like any other firmware
175 included with it (assuming you are in the root directory of the firmware):
178 $ make KEYBOARD=ergodox_ez KEYMAP=algernon
183 The keymap default to forcing NKRO, which seems to upset Windows, and except the
184 modifiers, none of them work. If you experience this problem, recompile the
185 firmware with `FORCE_NKRO=no` added to the `make` command line.
191 * The forced NKRO mode can be easily toggled off at compile-time, to make the
192 firmware compatible with [certain operating systems](#using-on-windows).
193 * The `:;` key has changed behaviour: to access the `;` symbol, the key needs to
194 be double-tapped, instead of shifted.
195 * The `=` and `\` keys were swapped, `=` moved to the home row, on both the
196 [base](#base-layer) and the [experimental](#experimental-layer) layers.
197 * The arrow and navigation keys were redone, they are now more accessible, but
198 the navigation keys require an extra tap to access.
199 * The **Emacs** layer is gone, replaced by a simplified
200 [navigation and media](#navigation-and-media-layer) layer.
201 * `LEAD v` types the firmware version, and the keymap version.
202 * On the [experimental](#experimental-layer) layer, the `L` and `Q`, and the `K`
203 and `G` keys were swapped.
204 * The [Steno](#steno-layer) layer gained a few more `#` and `*` keys, to make it
205 easier on my fingers.
209 * The keyboard starts in NKRO mode, bootmagic and other things are disabled.
210 * A [Steno](#steno-layer) layer was added, to be used with Plover.
211 * An [experimental](#experimental-layer) layer was added, something halfway
212 between Dvorak and Capewell-Dvorak. A work in progress.
213 * `LEAD y` types `\o/`.
214 * Some keys on the [Base](#base-layer) layer have been moved around:
215 - `?` moved to the left pinky, left of `Q`.
216 - `=` shifted one row down, but `F11` stayed where it was.
217 - `-` on the left half was replaced by `Tab`.
218 - `Tab`'s original position is taken by a `Media Next`/`Media Prev` key.
219 - `:` now inputs `;` when shifted.
220 * `ESC` cancels the [Hungarian](#hungarian-layer) layer too, not just modifiers.
228 The layout, being a derivative of the original TMK firmware which is under the
229 GPL-2+, this layout is under the GPL as well, but GPL-3+, rather than the older