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

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