keyboards/ergodox/keymaps/coderkun_neo2/readme.md

   1 # coderkun’s Neo2 layout for the ErgoDox EZ
   2
   3 The idea of this layout is to use it for [Neo2](http://www.neo-layout.org) but also provide layers to use QWERTZ with activated Neo driver and to use (basic) Neo when no driver is available (standard QWERTZ driver is active) (e. g. on other computers, in virtual machines) and to make heavily use of thumb keys.
   4
   5 The main goal of the default layer is to provide a complete symmetric layout with each modifier equally placed for both hands (mirror, of course).
   6
   7 It also features a layer for additional keys like F-keys (F1 – F12), some mouse keys and some useful Unicode symbols.
   8
   9
  10 ## Build
  11
  12     ```
  13     make clean
  14     make coderkun_neo2
  15     ```
  16
  17
  18 ## Keymap
  19
  20 0. Default layer for Neo2
  21 1. Poor man’s QWERTZ
  22 2. Poor man’s Neo
  23 3. F-keys, mouse keys und Unicode symbols
  24 4. Neo’s software layers 4 rebuilt in hardware
  25
  26
  27 ### Layer 0: Default layer for Neo2
  28
  29     ┌───────┬─────┬─────┬─────┬─────┬─────┬─────┐     ┌─────┬─────┬─────┬─────┬─────┬─────┬───────┐
  30     │  TAB  │  1  │  2  │  3  │  4  │  5  │  `  │     │  ´  │  6  │  7  │  8  │  9  │  0  │ BKSPC │
  31     ├───────┼─────┼─────┼─────┼─────┼─────┼─────┤     ├─────┼─────┼─────┼─────┼─────┼─────┼───────┤
  32     │   Y   │  X  │  V  │  L  │  C  │  W  │ HOM │     │ END │  K  │  H  │  G  │  F  │  Q  │  ß    │
  33     ├───────┼─────┼─────┼─────╆─────╅─────┤  E  │     │     ├─────╆─────╅─────┼─────┼─────┼───────┤
  34     │ Mod3  │  U  │  I  │  A  │  E  │  O  ├─────┤     ├─────┤  S  │  N  │  R  │  T  │  D  │ Mod3  │
  35     ├───────┼─────┼─────┼─────╄─────╃─────┤ TL2 │     │ TL3 ├─────╄─────╃─────┼─────┼─────┼───────┤
  36     │ LSHFT │  Ü  │  Ö  │  Ä  │  P  │  Z  │     │     │     │  B  │  M  │  ,  │  .  │  J  │ Shift │
  37     └─┬─────┼─────┼─────┼─────┼─────┼─────┴─────┘     └─────┴─────┼─────┼─────┼─────┼─────┼─────┬─┘
  38       │ CTL │ ALT │ MO1 │ Win │ Mod4│                             │ Mod4│ Win │ MO1 │ Alt │ CTL │
  39       └─────┴─────┴─────┴─────┴─────┘ ┌─────┬─────┐ ┌─────┬─────┐ └─────┴─────┴─────┴─────┴─────┘
  40                                       │  ←  │  ↑  │ │  ↓  │  →  │
  41                                 ┌─────┼─────┼─────┤ ├─────┼─────┼─────┐
  42                                 │     │     │  ─  │ │  ─  │     │     │
  43                                 │ SPC │ RTN ├─────┤ ├─────┤ RTN │ SPC │
  44                                 │     │     │ HYP │ │ MEH │     │     │
  45                                 └─────┴─────┴─────┘ └─────┴─────┴─────┘
  46
  47
  48 ### Layer 1: Poor man’s QWERTZ
  49
  50     ┌───────┬─────┬─────┬─────┬─────┬─────┬─────┐     ┌─────┬─────┬─────┬─────┬─────┬─────┬───────┐
  51     │  TAB  │  1  │  2  │  3  │  4  │  5  │  `  │     │  ´  │  6  │  7  │  8  │  9  │  0  │ BKSPC │
  52     ├───────┼─────┼─────┼─────┼─────┼─────┼─────┤     ├─────┼─────┼─────┼─────┼─────┼─────┼───────┤
  53     │   C   │  P  │  T  │  F  │  K  │  L  │ HOM │     │ END │  B  │  A  │  S  │  G  │  V  │  Y    │
  54     ├───────┼─────┼─────┼─────╆─────╅─────┤  E  │     │     ├─────╆─────╅─────┼─────┼─────┼───────┤
  55     │ Mod3  │  D  │  H  │  Ö  │  O  │  I  ├─────┤     ├─────┤  U  │  -  │  Z  │  E  │  X  │ Mod3  │
  56     ├───────┼─────┼─────┼─────╄─────╃─────┤(TL2)│     │(TL3)├─────╄─────╃─────┼─────┼─────┼───────┤
  57     │ LSHFT │  Ä  │  Q  │  R  │  W  │  N  │     │     │     │  J  │  M  │  ,  │  .  │  ẞ  │ Shift │
  58     └─┬─────┼─────┼─────┼─────┼─────┼─────┴─────┘     └─────┴─────┼─────┼─────┼─────┼─────┼─────┬─┘
  59       │ CTL │ ALT │ MO1 │ Win │ MO4 │                             │ M04 │ Win │ MO1 │ Alt │ CTL │
  60       └─────┴─────┴─────┴─────┴─────┘ ┌─────┬─────┐ ┌─────┬─────┐ └─────┴─────┴─────┴─────┴─────┘
  61                                       │  ←  │  ↑  │ │  ↓  │  →  │
  62                                 ┌─────┼─────┼─────┤ ├─────┼─────┼─────┐
  63                                 │     │     │  ─  │ │  ─  │     │     │
  64                                 │ SPC │ RTN ├─────┤ ├─────┤ RTN │ SPC │
  65                                 │     │     │ HYP │ │ MEH │     │     │
  66                                 └─────┴─────┴─────┘ └─────┴─────┴─────┘
  67
  68
  69 ### Layer 2: Poor man’s Neo
  70
  71     ┌───────┬─────┬─────┬─────┬─────┬─────┬─────┐     ┌─────┬─────┬─────┬─────┬─────┬─────┬───────┐
  72     │  TAB  │  1  │  2  │  3  │  4  │  5  │  `  │     │  ´  │  6  │  7  │  8  │  9  │  0  │ BKSPC │
  73     ├───────┼─────┼─────┼─────┼─────┼─────┼─────┤     ├─────┼─────┼─────┼─────┼─────┼─────┼───────┤
  74     │   Y   │  X  │  V  │  L  │  C  │  W  │ HOM │     │ END │  K  │  H  │  G  │  F  │  Q  │  ß    │
  75     ├───────┼─────┼─────┼─────╆─────╅─────┤  E  │     │     ├─────╆─────╅─────┼─────┼─────┼───────┤
  76     │ Mod3  │  U  │  I  │  A  │  E  │  O  ├─────┤     ├─────┤  S  │  N  │  R  │  T  │  D  │ Mod3  │
  77     ├───────┼─────┼─────┼─────╄─────╃─────┤(TL2)│     │(TL3)├─────╄─────╃─────┼─────┼─────┼───────┤
  78     │ LSHFT │  Ü  │  Ö  │  Ä  │  P  │  Z  │     │     │     │  B  │  M  │  ,  │  .  │  J  │ Shift │
  79     └─┬─────┼─────┼─────┼─────┼─────┼─────┴─────┘     └─────┴─────┼─────┼─────┼─────┼─────┼─────┬─┘
  80       │ CTL │ ALT │ MO1 │ Win │ MO4 │                             │ M04 │ Win │ MO1 │ Alt │ CTL │
  81       └─────┴─────┴─────┴─────┴─────┘ ┌─────┬─────┐ ┌─────┬─────┐ └─────┴─────┴─────┴─────┴─────┘
  82                                       │  ←  │  ↑  │ │  ↓  │  →  │
  83                                 ┌─────┼─────┼─────┤ ├─────┼─────┼─────┐
  84                                 │     │     │  ─  │ │  ─  │     │     │
  85                                 │ SPC │ RTN ├─────┤ ├─────┤ RTN │ SPC │
  86                                 │     │     │ HYP │ │ MEH │     │     │
  87                                 └─────┴─────┴─────┘ └─────┴─────┴─────┘
  88
  89
  90 ### Layer 3: F-keys, mouse keys und Unicode symbols
  91
  92     ┌───────┬─────┬─────┬─────┬─────┬─────┬─────┐     ┌─────┬─────┬─────┬─────┬─────┬─────┬───────┐
  93     │       │ F1  │ F2  │ F3  │ F4  │ F5  │ F6  │     │ F7  │ F8  │ F9  │ F10 │ F11 │ F12 │       │
  94     ├───────┼─────┼─────┼─────┼─────┼─────┼─────┤     ├─────┼─────┼─────┼─────┼─────┼─────┼───────┤
  95     │       │  ┌  │  ┬  │  ┐  │  ─  │  │  │     │     │     │  ↔  │  ←  │  →  │  ↑  │  ↓  │       │
  96     ├───────┼─────┼─────┼─────╆─────╅─────┤     │     │     ├─────╆─────╅─────┼─────┼─────┼───────┤
  97     │       │  ├  │  ┼  │  ┤  │ 〈  │  〉 ├─────┤     ├─────┤     │  ✓  │  ✕  │  •  │  ∶  │       │
  98     ├───────┼─────┼─────┼─────╄─────╃─────┤(TL2)│     │(TL3)├─────╄─────╃─────┼─────┼─────┼───────┤
  99     │       │  └  │  ┴  │  ┘  │     │     │     │     │     │  ⇔  │  ⇐  │  ⇒  │  ⇑  │  ⇓  │       │
 100     └─┬─────┼─────┼─────┼─────┼─────┼─────┴─────┘     └─────┴─────┼─────┼─────┼─────┼─────┼─────┬─┘
 101       │     │     │(MO1)│     │(MO4)│                             │(MO4)│     │(MO1)│     │     │
 102       └─────┴─────┴─────┴─────┴─────┘ ┌─────┬─────┐ ┌─────┬─────┐ └─────┴─────┴─────┴─────┴─────┘
 103                                       │ Ms← │ Ms↑ │ │ Ms↓ │ Ms→ │
 104                                 ┌─────┼─────┼─────┤ ├─────┼─────┼─────┐
 105                                 │     │     │ MLC │ │ MRC │     │     │
 106                                 │     │     ├─────┤ ├─────┤     │     │
 107                                 │     │     │     │ │     │     │     │
 108                                 └─────┴─────┴─────┘ └─────┴─────┴─────┘
 109
 110
 111 ### Layer 4: Neo’s software layers 4 rebuilt in hardware
 112
 113     ┌───────┬─────┬─────┬─────┬─────┬─────┬─────┐     ┌─────┬─────┬─────┬─────┬─────┬─────┬───────┐
 114     │       │     │     │     │     │     │     │     │     │     │     │     │     │     │       │
 115     ├───────┼─────┼─────┼─────┼─────┼─────┼─────┤     ├─────┼─────┼─────┼─────┼─────┼─────┼───────┤
 116     │       │ PgUp│ BSpc│  ↑  │ Del │ PgDn│     │     │     │     │  7  │  8  │  9  │  +  │   −   │
 117     ├───────┼─────┼─────┼─────╆─────╅─────┤     │     │     ├─────╆─────╅─────┼─────┼─────┼───────┤
 118     │       │ Home│  ←  │  ↓  │  →  │ End ├─────┤     ├─────┤     │  4  │  5  │  6  │  ,  │   .   │
 119     ├───────┼─────┼─────┼─────╄─────╃─────┤(TL2)│     │(TL3)├─────╄─────╃─────┼─────┼─────┼───────┤
 120     │       │ Esc │ Tab │ Ins │ Ret │ Undo│     │     │     │     │  1  │  2  │  3  │     │       │
 121     └─┬─────┼─────┼─────┼─────┼─────┼─────┴─────┘     └─────┴─────┼─────┼─────┼─────┼─────┼─────┬─┘
 122       │     │     │(MO1)│     │(MO4)│                             │(MO4)│     │(MO1)│     │     │
 123       └─────┴─────┴─────┴─────┴─────┘ ┌─────┬─────┐ ┌─────┬─────┐ └─────┴─────┴─────┴─────┴─────┘
 124                                       │     │     │ │     │     │
 125                                 ┌─────┼─────┼─────┤ ├─────┼─────┼─────┐
 126                                 │     │     │     │ │     │     │     │
 127                                 │     │     ├─────┤ ├─────┤     │     │
 128                                 │     │     │     │ │     │     │     │
 129                                 └─────┴─────┴─────┘ └─────┴─────┴─────┘