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.
15 [![Base layer](images/base-layer.png)](http://www.keyboard-layout-editor.com/#/gists/28f7eb305fdbff943613e1dc7aa9e82b)
17 At its core, this is a Dvorak layout, with some minor changes (for example, `-`
18 being on the left half, and on the innermost key of the bottom row on the
19 right). The more interesting parts are how certain keys behave:
21 * The keys on the number row double as function keys, when held for a bit longer
22 than an usual tap. This allows me to use the function keys without having to
24 * The `Shift`, `Alt`, and `Control` modifiers are one-shot. When tapped, they
25 are considered active for the next key press only. When double tapped, they
26 toggle on, until a third, single tap sometime later. When held, they act as
27 expected. My usual pattern is that I use these for the next keypress only, so
28 this behaviour is perfect. If I need them held, I'll just double-tap.
29 * The `GUI` key is special, because when I double-tap it, it sends `GUI + w`,
30 which pops up an application selector. It also switches to a one-shot layer,
31 where the number row on the left half turns into app selector macros, for the
32 most common things I usually want to switch to. Otherwise it behaves as on a
34 * The `ESC` key also doubles as a one-shot cancel key: if tapped while any of
35 the one-shot modifiers are in-flight (as in, single-tapped, and not expired
36 yet), it cancels all one-shot modifiers. Otherwise it sends the usual keycode.
37 * The **Emacs** and **Hun** layer keys are one-shot, the **1Hand** and **STENO**
39 * The **Lead** key allows me to type in a sequence of keys, and trigger some
41 - `LEAD u` enters unicode input mode, by sending the GTK+ key sequence that
43 - `LEAD l` uses the unicode input method to enter a `λ`.
44 - `LEAD s` does a lot of magic to type in a shruggie: `¯\_(ツ)_/¯`
45 - `LEAD y` types `\o/`.
46 - `LEAD w m` maximises the currently focused window.
47 - `LEAD e` makes the [experimental layer](#experimental-layer) the default.
48 - `LEAD v` prints the firmware version, the keyboard and the keymap, if
49 compiled with a QMK version that has these available.
53 [![Hungarian layer](images/hun-layer.png)](http://www.keyboard-layout-editor.com/#/gists/b160f6ec90d58c127c114c89f66e9dc9)
55 On this layer, the accented characters are at the same position as their base
56 variant. For some, which can have other diatribes, the long one is on top,
57 short's on bottom. Tapping any of the accented characters takes us back to the
62 [![Emacs layer](images/emacs-layer.png)](http://www.keyboard-layout-editor.com/#/gists/c59c453f9fe1a3238ba1494e7e5c6892)
64 This layer is primarily for navigating text - and for some mousing and other
65 things, because there was space. Most of the keys should be pretty
66 self-explanatory, except for a few:
68 * There are three keys on the bottom row of the left side, that change how some
69 of the other keys - explained just below - work. The keys are for *Emacs
70 mode* (the default), *Terminal mode*, and *Traditional mode*, respectively.
71 * The *Visual mode* key (the top big key on the left side) sends the `v` key in
72 *Emacs mode*, to enter Visual mode in Spacemacs. In all other modes, it is a
74 * The *Copy/Cut* key (the bottom big key on the left side) sends the copy
75 command on tap, the cut one when held for longer than a normal tap. The **copy
76 command** is `y` in *Emacs mode*, `Ctrl-Shift-c` in *Terminal mode*, and
77 `Ctrl-c` in *Traditional mode*. The **cut command** is `x` in *Emacs mode*,
78 `Ctrl-Shift-x` in *Terminal Mode* and `Ctrl-x` in *Traditional mode*.
79 * The *Paste/Delete* key (the leftmost key on the left thumb cluster) sends the
80 paste command on tap, the delete one when held longer than a normal tap. The
81 **paste command** is `p` in *Emacs mode*, `Ctrl-Shift-v` in *Terminal mode*,
82 and `Ctrl-v` in *Traditional mode*. The **delete command** is `d` in *Emacs
83 mode*, and `DEL` in the other two.
84 * The `A`, `I` and `R` keys will - after sending themselves - clear the layer
85 back to the base layer. This allows a quick escape from the layer.
89 [![One-handed layer](images/one-handed-layer.png)](http://www.keyboard-layout-editor.com/#/gists/edff2495135955b8963198dace7f7ece)
91 The one-handed layer is used in situations where the right hand is occupied, by
92 mousing around, for example. Tapping the `OTHER` key switches which side is
93 active. For the most part, keys remain in their usual position. When the right
94 half is active, keys are mirrored to the left half.
96 The differences are as follows:
98 * The `ESC` key has been moved to the bottom row, so the `OTHER` key is easier
100 * Most keys on the thumb cluster now have dual uses, and these do not change
101 when switching sides:
102 - The `Space`/`Backspace` key sends `Space` on tap, `Backspace` when held
103 for longer than a normal tap.
104 - The `Enter`/`Shift` key sends `Enter` on short-tap, `Shift` on long-tap.
105 * The `Apps`/`BASE` key can be used to go back to the base layer, by
106 long-tapping it. A short-tap will send the `App` key, as usual.
110 [![Steno layer for Plover](images/steno-layer.png)](http://www.keyboard-layout-editor.com/#/gists/401ef9a84369e47c57f9aedcf0a0d667)
112 This is to be used with [Plover](http://www.openstenoproject.org/plover/),
113 nothing really fancy here. The **STENO** key toggles the layer on and off, and
114 sends the toggle command to Plover too.
116 ## Experimental layer
118 [![Experimental layer](images/experimental-layer.png)](http://www.keyboard-layout-editor.com/#/gists/6ff50bf71248e05aab5b3fec4fae3d08)
120 While using the standard Dvorak layout, I encountered a number of
121 inconveniences, and on this layer, I am playing with ideas to make the layout
122 feel better. Initially, it was based on [Capewell-Dvorak][cpd], but that too,
123 had shortcomings I was not happy with. So now this is something inbetween, with
124 own observations thrown in. How it works out in the long run remains to be seen.
126 [cpd]: http://www.michaelcapewell.com/projects/keyboard/layout_capewell-dvorak.htm
130 To make my workflow easier, this layout is maintained in
131 [its own repository][algernon:ez-layout]. To build it, you will need the
132 [QMK][qmk] firmware checked out, and this repo either checked out, or symlinked
133 to `keyboards/ergodox_ez/algernon`. One way to achieve that is this:
135 [algernon:ez-layout]: https://github.com/algernon/ergodox-layout
136 [qmk]: https://github.com/jackhumbert/qmk_firmware
139 $ git clone https://github.com/jackhumbert/qmk_firmware.git
140 $ cd qmk_firmware/keyboards/ergodox_ez
141 $ git clone https://github.com/algernon/ergodox-layout.git keymaps/algernon
142 $ make KEYMAP=algernon
145 From time to time, updates may be submitted back to the QMK repository. If you
146 are reading it there, you can build the firmware like any other firmware
147 included with it (assuming you are in the root directory of the firmware):
150 $ cd keyboards/ergodox_ez
151 $ make KEYMAP=algernon
156 The layout, being a derivative of the original TMK firmware which is under the
157 GPL-2+, this layout is under the GPL as well, but GPL-3+, rather than the older