keyboards/ergodox/keymaps/win10_writers-block/readme.md

   1 <!-- -*- mode: markdown; fill-column: 8192 -*- -->\r
   2 \r
   3 Win10 Writer's Block ErgoDox - v1.0\r
   4 \r
   5 =======================\r
   6 \r
   7 This is a QWERTY layout for QMK. It's designed to work well in MS Office-like environments. It's tested on Windows 7 and 10.\r
   8 \r
   9 Professional writers may find this layout useful -- copywriters, technical writers, novelists, etc.  \r
  10 \r
  11 I use my ErgoDox with this keymap as a daily driver at my office.\r
  12 \r
  13 A gaming layer is unobtrusively built into this layout. I use that layer to play RimWorld. \r
  14 \r
  15 Feel free to modify the gaming layer to your personal taste.\r
  16 \r
  17 ## Table of Contents\r
  18 \r
  19 * [Layouts](#layouts)\r
  20     - [Base layer](#base-layer)\r
  21     - [Symbol layer](#symbol-layer)\r
  22     - [Gaming layer](#rimworld-layer)\r
  23     - [Media layer](#media-layer)\r
  24 * [Tools](#tools)\r
  25     - [Layer notification](#layer-notification)\r
  26 * [Building](#building)\r
  27     - [Using on Windows](#using-on-windows)\r
  28 * [License](#license)\r
  29 * [Special Thanks](#special-thanks)\r
  30 \r
  31 # Layouts\r
  32 \r
  33 * TapDance will teleport you to the layer you want: \r
  34 * One Tap for the Base layer\r
  35 * Two Taps for the Symbol layer\r
  36 * Three Taps for the Rimworld/Gaming layer\r
  37 \r
  38 * Where the "Meh" key is located on the Ergodox EZ default layout, I've changed it to another tap dance key:\r
  39 * One Tap for CTRL-ALT-DEL\r
  40 * Two Taps for the Media/Mouse layer\r
  41 \r
  42 ## Base layer\r
  43 \r
  44 [![Base layer](images/base-layer.png)](http://www.keyboard-layout-editor.com/#/gists/8fd9bbdd3a23bbb5a8779de3624a3be1)\r
  45 \r
  46 This is a QWERTY layout with some quirks. \r
  47 \r
  48 * Enter is located on a key that won't cause as much thumb fatigue.  \r
  49 * Copy and Paste work from the same key. Just hold the key to copy and tap the key to paste!\r
  50 * Undo, Find and Cut are also one-touch keys. \r
  51 * F12 is where you would normally find TAB on standard layouts. Quickly save in Word, safely.\r
  52 * You'll find bracket keys below the "6" key.\r
  53 \r
  54 * The Meh Key is a single-button CTRL+ALT+SHIFT modifier.\r
  55 \r
  56 * Space Cadet Shift: Tap L Shift for "(" and R Shift for ")" -- holding either shift works like a normal shift.\r
  57 * Tap "Z" or Tab to use either normally. Hold them for CTRL. \r
  58 * Tap Caps Lock to use it normally. Hold it for Win key combinations (Win+D to minimize all programs, etc).\r
  59 \r
  60 ## Symbol layer\r
  61 \r
  62 [![Symbol layer](images/symbol-layer.png)](http://www.keyboard-layout-editor.com/#/gists/04eb6458b8b17882e472f64d482f12b4)\r
  63 \r
  64 Your standard Ergodox EZ symbol + numpad layout, minus the Version and EEPROM keys.\r
  65 \r
  66 * From the base layer, hold the F12 Key to temporarily access this layer (use for quick access to numpad)\r
  67 * Release F12 to return to the base layer.\r
  68 \r
  69 ## Rimworld layer\r
  70 \r
  71 [![Rimworld / Gaming Layer](images/rimworld-layer.png)](http://www.keyboard-layout-editor.com/#/gists/d53af8391e6e443ed0a98ccfbdb4eace)\r
  72 \r
  73 This layer was made to play RimWorld, a Sci-Fi Colony Survival Game by Tynan Sylvester and Ludeon Studios, available on Steam. \r
  74 \r
  75 * Have fun!\r
  76 \r
  77 ## Media layer\r
  78 \r
  79 [![Media layer](images/media-layer.png)](http://www.keyboard-layout-editor.com/#/gists/3209d09ed4bd997e4f49f28c6ada2ab3)\r
  80 \r
  81 This is the standard Ergodox EZ media layout with more options for mouseclick buttons. \r
  82 \r
  83 * In this layer, your "space" key changes into a back button for your browser.\r
  84 \r
  85 ## LED states\r
  86 \r
  87 Your LEDs will change to indicate your layer. You'll know you are in the base layer if all LEDs are off.\r
  88 \r
  89 # Building\r
  90 \r
  91 To build, you will need the [QMK][qmk] firmware checked out. from there, dive into `keyboards/ergodox/keymaps/win10_writers-block/`\r
  92 \r
  93 [qmk]: https://github.com/jackhumbert/qmk_firmware\r
  94 \r
  95 ```\r
  96 $ make keyboard=ergodox keymap=win10_writers-block\r
  97 ```\r
  98 \r
  99 ## Using on Windows\r
 100 \r
 101 This layout is tested in Windows 7 Pro and Windows 10 Home environments. \r
 102 \r
 103 # License\r
 104 \r
 105 GPL 3+\r
 106 \r
 107 # Special Thanks\r
 108 \r
 109 * To algernon for his coding help. I'm a novice but I still made this work (and figured out tap dance) with his help.\r
 110 \r
 111 * To /r/MechanicalKeyboards for being an all-around great community.\r
 112 \r
 113 * To /u/profet23 for his amazing custom Ergodox boards.