keyboards/ergodox/keymaps/yoruian/README

   1           Snarfangel's YORUIAN for the ErgoDox EZ
   2           ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
   3 DEFAULT
   4 ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
   5 ┃ ` │ ; │ : │ - │ / │ ( │ < ┃ ┃ > │ ) │ ^ │ * │ ~ │ Γ │ σ ┃
   6 ┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
   7 ┃ ⎋ │ . │ y │ o │ r │ ? │ ✦ ┃ ┃ ✦ │ j │ v │ d │ f │ w │ q ┃
   8 ┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
   9 ┃ ⎈ │ u │ i │ a │ n │ ! ├───┨ ┠───┤ m │ h │ t │ s │ c │ ⎈ ┃
  10 ┠───┼───┼───┼───┼───┼───┤ ❖ ┃ ┃ ❖ ├───┼───┼───┼───┼───┼───┨
  11 ┃ λ │ ' │ " │ , │ _ │ = │   ┃ ┃   │ k │ l │ p │ g │ b │ x ┃
  12 ┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
  13 ┃ ⎀ │ E │   │   │ ◆ ┃                 ┃ ◆ │   │   │ z │ ⎙ ┃
  14 ┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
  15                     ┏━━━┯━━━┓ ┏━━━┯━━━┓
  16                     ┃ ⌫ │ ⌥ ┃ ┃ ⎄ │ ↹ ┃
  17                 ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
  18                 ┃   │   │   ┃ ┃   │   │   ┃
  19                 ┃ e │ ⇧ ├───┨ ┠───┤ ⏎ │ ␣ ┃
  20                 ┃   │   │   ┃ ┃   │   │   ┃
  21                 ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛
  22 SHIFTED
  23 ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
  24 ┃ 9 │ 7 │ 5 │ 3 │ 1 │ [ │ { ┃ ┃ } │ ] │ 0 │ 2 │ 4 │ 6 │ 8 ┃
  25 ┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
  26 ┃   │ * │ Y │ O │ R │ \ │   ┃ ┃   │ J │ V │ D │ F │ W │ Q ┃
  27 ┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
  28 ┃   │ U │ I │ A │ N │ | ├───┨ ┠───┤ M │ H │ T │ S │ C │   ┃
  29 ┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
  30 ┃   │ # │ $ │ @ │ & │ + │   ┃ ┃   │ K │ L │ P │ G │ B │ X ┃
  31 ┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
  32 ┃   │   │   │   │   ┃                 ┃   │   │   │ Z │   ┃
  33 ┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
  34                     ┏━━━┯━━━┓ ┏━━━┯━━━┓
  35                     ┃   │   ┃ ┃   │   ┃
  36                 ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
  37                 ┃   │   │   ┃ ┃   │   │   ┃
  38                 ┃   │   ├───┨ ┠───┤   │   ┃
  39                 ┃   │   │   ┃ ┃   │   │   ┃
  40                 ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛
  41 λ LAYER
  42 ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
  43 ┃   │   │   │   │   │   │   ┃ ┃   │   │ ⑤ │ ⑥ │ ⑦ │ ⑧ │ ⑨ ┃
  44 ┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
  45 ┃   │   │   │   │   │   │   ┃ ┃   │   │ ① │ ② │ ③ │ ④ │ ⑩ ┃
  46 ┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
  47 ┃   │   │   │   │   │   ├───┨ ┠───┤ ⎉ │ ← │ ↓ │ ↑ │ → │ ⑪ ┃
  48 ┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
  49 ┃ λ │   │   │   │   │   │   ┃ ┃   │   │ ⇱ │ ⎘ │ ⎗ │ ⇲ │ ⑫ ┃
  50 ┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
  51 ┃   │   │   │   │   ┃                 ┃   │   │   │   │   ┃
  52 ┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
  53                     ┏━━━┯━━━┓ ┏━━━┯━━━┓
  54                     ┃   │   ┃ ┃   │   ┃
  55                 ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
  56                 ┃   │   │   ┃ ┃   │   │   ┃
  57                 ┃   │   ├───┨ ┠───┤   │   ┃
  58                 ┃   │   │   ┃ ┃   │   │   ┃
  59                 ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛
  60
  61 Installation (X only)
  62 ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
  63    1. Build and flash firmware as usual
  64
  65    2. sudo make install-xorg-configuration
  66
  67    3. Restart X
  68
  69 Features
  70 ‾‾‾‾‾‾‾‾
  71    • E on the thumb
  72
  73    • Emacs-friendly
  74
  75    • Symmetric control keys for finger wear levelling
  76
  77    • Greek and subscript dead keys
  78
  79    • Compose key for arbitrary Unicode input via ~/.XCompose
  80
  81 Don't Cares
  82 ‾‾‾‾‾‾‾‾‾‾‾
  83    • Easy migration from QWERTY
  84
  85    • Compatbility with non-XKB systems
  86
  87    • Mouse emulation
  88
  89    • Media keys
  90
  91 Acknowledgements
  92 ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
  93 Snarfangel, for designing the layout.
  94
  95 The GNU FreeFont project and Steve White, for adding new keyboard
  96 symbols.
  97
  98 Xah Lee, for http://xahlee.info/comp/unicode_computing_symbols.html
  99
 100 Colophon
 101 ‾‾‾‾‾‾‾‾
 102 This file is best-viewed with an SVN version of GNU FreeFont Mono.