keyboard/ergodox_ez/keymaps/algernon/README.md

   1 algernon's layout
   2 =======================
   3
   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].
   7
   8  [blog-ergodox]: https://asylum.madhouse-project.org/blog/tags/ergodox/
   9
  10 Some of the things in the layout only work when one uses Spacemacs and GNOME
  11 under Linux. Your mileage may vary.
  12
  13 ## Base layer
  14
  15 [![Base layer](images/base-layer.png)](http://www.keyboard-layout-editor.com/#/gists/28f7eb305fdbff943613e1dc7aa9e82b)
  16
  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:
  20
  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
  23   switch layers.
  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
  33   normal layout.
  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** is a toggle.
  38 * The **Lead** key allows me to type in a sequence of keys, and trigger some
  39   actions:
  40     - `LEAD u` enters unicode input mode, by sending the GTK+ key sequence that
  41       does this.
  42     - `LEAD l` uses the unicode input method to enter a `λ`.
  43     - `LEAD s` does a lot of magic to type in a shruggie: `¯\_(ツ)_/¯`
  44     - `LEAD w m` maximises the currently focused window.
  45
  46 ## Hungarian layer
  47
  48 [![Hungarian layer](images/hun-layer.png)](http://www.keyboard-layout-editor.com/#/gists/b160f6ec90d58c127c114c89f66e9dc9)
  49
  50 On this layer, the accented characters are at the same position as their base
  51 variant. For some, which can have other diatribes, the long one is on top,
  52 short's on bottom. Tapping any of the accented characters takes us back to the
  53 base layer.
  54
  55 ## Emacs layer
  56
  57 [![Emacs layer](images/emacs-layer.png)](http://www.keyboard-layout-editor.com/#/gists/c59c453f9fe1a3238ba1494e7e5c6892)
  58
  59 This layer is primarily for navigating text - and for some mousing and other
  60 things, because there was space. Most of the keys should be pretty
  61 self-explanatory, except for a few:
  62
  63 * There are three keys on the bottom row of the left side, that change how some
  64   of the other keys - explained just below - work. The keys are for *Emacs
  65   mode* (the default), *Terminal mode*, and *Traditional mode*, respectively.
  66 * The *Visual mode* key (the top big key on the left side) sends the `v` key in
  67   *Emacs mode*, to enter Visual mode in Spacemacs. In all other modes, it is a
  68   no-op.
  69 * The *Copy/Cut* key (the bottom big key on the left side) sends the copy
  70   command on tap, the cut one when held for longer than a normal tap. The **copy
  71   command** is `y` in *Emacs mode*, `Ctrl-Shift-c` in *Terminal mode*, and
  72   `Ctrl-c` in *Traditional mode*. The **cut command** is `x` in *Emacs mode*,
  73   `Ctrl-Shift-x` in *Terminal Mode* and `Ctrl-x` in *Traditional mode*.
  74 * The *Paste/Delete* key (the leftmost key on the left thumb cluster) sends the
  75   paste command on tap, the delete one when held longer than a normal tap. The
  76   **paste command** is `p` in *Emacs mode*, `Ctrl-Shift-v` in *Terminal mode*,
  77   and `Ctrl-v` in *Traditional mode*. The **delete command** is `d` in *Emacs
  78   mode*, and `DEL` in the other two.
  79 * The `A`, `I` and `R` keys will - after sending themselves - clear the layer
  80   back to the base layer. This allows a quick escape from the layer.
  81
  82 ## One-handed layer
  83
  84 [![One-handed layer](images/one-handed-layer.png)](http://www.keyboard-layout-editor.com/#/gists/edff2495135955b8963198dace7f7ece)
  85
  86 The one-handed layer is used in situations where the right hand is occupied, by
  87 mousing around, for example. Tapping the `OTHER` key switches which side is
  88 active. For the most part, keys remain in their usual position. When the right
  89 half is active, keys are mirrored to the left half.
  90
  91 The differences are as follows:
  92
  93 * The `ESC` key has been moved to the bottom row, so the `OTHER` key is easier
  94   to tap.
  95 * Most keys on the thumb cluster now have dual uses, and these do not change
  96   when switching sides:
  97     - The `Space`/`Backspace` key sends `Space` on tap, `Backspace` when held
  98       for longer than a normal tap.
  99     - The `Enter`/`Shift` key sends `Enter` on short-tap, `Shift` on long-tap.
 100 * The `Apps`/`BASE` key can be used to go back to the base layer, by
 101   long-tapping it. A short-tap will send the `App` key, as usual.
 102
 103 # Building
 104
 105 To make my workflow easier, this layout is maintained in
 106 [its own repository][algernon:ez-layout]. To build it, you will need the
 107 [QMK][qmk] firmware checked out, and this repo either checked out, or symlinked
 108 to `keyboard/ergodox_ez/algernon`. One way to achieve that is this:
 109
 110  [algernon:ez-layout]: https://github.com/algernon/ergodox-layout
 111  [qmk]: https://github.com/jackhumbert/qmk_firmware
 112
 113 ```
 114 $ git clone https://github.com/jackhumbert/qmk_firmware.git
 115 $ cd qmk_firmware/keyboard/ergodox_ez
 116 $ git clone https://github.com/algernon/ergodox-layout.git keymaps/algernon
 117 $ make KEYMAP=algernon
 118 ```
 119
 120 From time to time, updates may be submitted back to the QMK repository. If you
 121 are reading it there, you can build the firmware like any other firmware
 122 included with it (assuming you are in the root directory of the firmware):
 123
 124 ```
 125 $ cd keyboard/ergodox_ez
 126 $ make KEYMAP=algernon
 127 ```
 128
 129 # License
 130
 131 The layout, being a derivative of the original TMK firmware which is under the
 132 GPL-2+, this layout is under the GPL as well, but GPL-3+, rather than the older
 133 version.