keyboards/ergodox/keymaps/deadcyclo/readme.md

   1 # ErgoDox EZ 1337 configuration
   2
   3 Custom layout based on the default layout. Intended for interational
   4 users of us intl-altgr layout. Note that some common keys might be
   5 missing, as this layout is intented to be used on *nix systems by
   6 users familiar with their system. The layout is geared towards
   7 avoiding using the rat (mouse for those of you who are unfamiliar with
   8 tiling window managers) as much as possibly.
   9
  10 # Layouts
  11
  12 All layer images created using [keyboard-layout-editor](http://www.keyboard-layout-editor.com/)
  13
  14 ## Base layer
  15
  16 [![Base layer](images/deadcyclo-base-layout.png)](http://www.keyboard-layout-editor.com/#/gists/0321b18620180a3e46c498206eb65366)
  17
  18 The base layer here is marked with the us international alt-gr layout,
  19 including characters bound to what on an iso keyboard would be alt-gr
  20 and on an ansi keyboard right alt.
  21
  22 Regular (and irregular) modifier keys are marked with a yellowish
  23 gray. Layer moderators are marked with blue, red and green, which are
  24 the same colors each layer displays on the LEDs when active.
  25
  26 All of the layer switch keys, except for the two center keys marked L1
  27 TOG, are dual purpose. Hence for example the top left key produces ESC
  28 if tapped, and temporarilly toggles L3 when hold down. The two center
  29 L1 TOG keys toggle L1 on and off for more permanent layer toggling.
  30
  31 The UNI keys enter the linux ibus unicode composer mode
  32 (ie. Ctrl+Shift+u). Use this to enter unicode characters. Hit the key,
  33 type in the unicode hex value, and hit enter.
  34
  35 ## Layer 1 - Symbols and RGB
  36
  37 [![Layer 1 - Symbols and RGB](images/deadcyclo-layer-1-symbols.png)](http://www.keyboard-layout-editor.com/#/gists/96714e198054c9115bafb5267cc6bc73)
  38
  39 The Symbols and RGB layer contains function keys, commonly used
  40 symbols, a numpad and if you have the new Ergodox Ez shine keys for
  41 controlling various RGB-led functions. In addition, it provides an up
  42 and a down key for easy scrolling. RGB controller keys are yellow.
  43
  44 ## Layer 2 - Media, Mouse and Navigation
  45
  46 [![Layer 2 - Media, Mouse and Navigation](images/deadcyclo-layer-2-media-and-mouse.png)](http://www.keyboard-layout-editor.com/#/gists/824759486e378bcec30784309a7e5731)
  47
  48 The Media, Mouse and unicode layer contains special keys for moving
  49 the mouse and clicking on it with the keyboard. In addition it
  50 provides standard media control keys, and default arrow keys.
  51
  52 ## Layer 3 - Unicode
  53
  54 [![Layer 3 - Unicode](images/deadcyclo-layer-3-unicode.png)](http://www.keyboard-layout-editor.com/#/gists/67d9613dcd873c68693d11863d0fd289)
  55
  56 The unicode layer provides keys for directly typing unicode (utf-8)
  57
  58 ## Layer 4 - Unicode 2
  59
  60 [![Layer 43 - Unicode](images/deadcyclo-layer-4-unicode-2.png)](http://www.keyboard-layout-editor.com/#/gists/7b2241110ab8311d9668a0798f3baf4a)
  61
  62 The unicode 2 layer provides keys for directly typing unicode (utf-8)
  63
  64 # Changelog
  65
  66 - 02.01.2017 Added delete key on second layer
  67 - 10.01.2017 Added layer images to readme
  68 - 24.01.2017 Added support for Ergodox Shine. Added secondary L2 switch key on left hand
  69 - 24.01.2017 Added unicode keys. Added shrug hug and yay. Moved Navigation to layer 2
  70 - 25.01.2017 Added lots of new emojis and some unicode keys
  71 - 27.01.2017 Added new unicode keys and shortcut for ibus unicode composer key (CTRL+SHIFT+U)
  72 - 11.03.2017 Added additional unicode layer. Moved some layer switch keys to more sane locations
  73
  74 # TODO
  75
  76 - Add macros for lots of stuff. (Lastpass cli, pushbullet cli, other push service cli, linode cli, more?)
  77 - Make macros for gnu screen and i3wm
  78 - Look into the app launch macros in algernon keymap
  79