layouts/community/ergodox/qwerty_code_friendly/readme.md

   1 # ErgoDox EZ Code Friendly Qwerty Layout
   2
   3 - This layout aims to balance muscle memory from a typical QWERTY layout
   4   with having keys used for software development easily accessible.
   5
   6 - Arrow keys follow VIM convention
   7   (the media layer even uses arrow keys for HJKL).
   8
   9 - On the top row only symbols are used (not numbers),
  10   it's expected the symbol layer's number-pad layout will be used for numbers.
  11
  12 - Symbols match regular QWERTY.
  13   except for '()' which are grouped with other brackets.
  14   In their place -/= keys are placed, which almost matches a regular layout.
  15
  16 - Brackets are placed symmetrically along the center edges,
  17   if using keys from both sides is inconvenient - the symbol layer has macros
  18   at the same key locations to type matching pairs.
  19
  20 - The extra space-bar on the lower-left looks like it's in an obscure location,
  21   however using the larger thumb cluster
  22   ended up being more of a reach while typing.
  23
  24 - There is a handy shortcut for writing quotes that inserts the cursor
  25   between the quotation marks.
  26
  27   Holding LShift, then RShift types: "" (then presses left).
  28
  29   Holding RShift, then LShift types: '' (then presses left).
  30
  31 ## Configuration
  32
  33 Some optional behavior is configurable without editing the code
  34 using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
  35
  36 - `CFQ_USER_KEY0`
  37   (0..7) are used for custom-keys
  38 - `CFQ_USE_MOMENTARY_LAYER_KEYS`
  39   is used to prevent layer keys from toggling when tapped.
  40 - `CFQ_WORD_[A-Z]`
  41   defines can bind a key to an entire user defined word.
  42
  43
  44
  45 ## Keymap 0: Basic layer
  46
  47 ```
  48 ,--------------------------------------------------.           ,--------------------------------------------------.
  49 | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
  50 |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
  51 | Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
  52 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  53 | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
  54 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
  55 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  56 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  57   | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Ins  |
  58   `----------------------------------'                                       `----------------------------------'
  59                                        ,-------------.       ,-------------.
  60                                        |   <  |  >   |       | Home | End  |
  61                                 ,------+------+------|       |------+------+------.
  62                                 |      |      |CapsLk|       | PgUp |      |      |
  63                                 |BSpace| Del  |------|       |------| ~L2  |Space |
  64                                 |      |      | ~L3  |       | PgDn |      |      |
  65                                 `--------------------'       `--------------------'
  66
  67 Optional overrides: see CFQ_USER_KEY# defines.
  68
  69 ,--------------------------------------------------.           ,--------------------------------------------------.
  70 |        |      |      |      |      |      |      |           |      |      |      |      |      |      | USR0   |
  71 |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
  72 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  73 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  74 |        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
  75 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  76 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  77 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  78   |      |      |      | USR1 |      |                                       |      |      |      |      |      |
  79   `----------------------------------'                                       `----------------------------------'
  80                                        ,-------------.       ,-------------.
  81                                        | USR2 | USR3 |       |      |      |
  82                                 ,------+------+------|       |------+------+------.
  83                                 |      |      | USR6 |       |      |      |      |
  84                                 | USR4 | USR5 |------|       |------|      |      |
  85                                 |      |      | USR7 |       |      |      |      |
  86                                 `--------------------'       `--------------------'
  87 ```
  88
  89 ## Keymap 1: KeyPad, Macro Record
  90
  91 Notes:
  92
  93 - The double bracket keys on this layer press left to position the cursor between them.
  94 - The left thumb cluster is used for macro record/replay.
  95
  96 ```
  97 ,--------------------------------------------------.           ,--------------------------------------------------.
  98 |        |      |      |      |      |      |  {}  |           |  }{  |      |NumLck|   /  |   *  |   -  |        |
  99 |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 100 |        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   +  |        |
 101 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 102 |        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   +  |        |
 103 |--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
 104 |        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  | Enter|        |
 105 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 106   |      |      |      |      |      |                                       |   0  |      |   .  | Enter|      |
 107   `----------------------------------'                                       `----------------------------------'
 108                                        ,-------------.       ,--------------.
 109                                        |Start1|Start2|       |      |       |
 110                                 ,------+------+------|       |------+-------+------.
 111                                 |      |      | Stop |       |      |       |      |
 112                                 |Play1 |Play2 |------|       |------|       |      |
 113                                 |      |      |      |       |      |       |      |
 114                                 `--------------------'       `---------------------'
 115 ```
 116
 117 ## Keymap 2: Keymap 2: Media and mouse keys
 118
 119 ```
 120 ,--------------------------------------------------.           ,--------------------------------------------------.
 121 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 122 |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 123 |        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
 124 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 125 |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
 126 |--------+------+------+------+------+------|MWhlDn|           |      |------+------+------+------+------+--------|
 127 |        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
 128 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 129   |      |      |      |      |      |                                       |      |      |      |      |      |
 130   `----------------------------------'                                       `----------------------------------'
 131                                        ,-------------.       ,-------------.
 132                                        | MRwd | MFwd |       | MPrv | MNxt |
 133                                 ,------+------+------|       |------+------+------.
 134                                 |      |      |      |       |VolUp |      |      |
 135                                 | Mute |      |------|       |------|      | Play |
 136                                 |      |      |      |       |VolDn |      |      |
 137                                 `--------------------'       `--------------------'
 138 ```
 139
 140 ## Keymap 3: K-Keys & User defined words
 141
 142 This is for assigning whole words to single keys.
 143 You can define the arguments (which must be quoted) using: `CFQ_WORD_[A-Z]`
 144 eg: `-DCFQ_WORD_E=\"my@email.com\"`
 145
 146 ```
 147 ,--------------------------------------------------.           ,--------------------------------------------------.
 148 |        |  F1  |  F2  |  F3  |  F4  |  F5  |  F11 |           | F12  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
 149 |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 150 |        |   Q  |   W  |   E  |   R  |   T  |      |           |      |   Y  |   U  |   I  |   O  |   P  |        |
 151 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 152 |        |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |      |        |
 153 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 154 |        |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |      |      |      |        |
 155 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 156   |      |      |      |      |      |                                       |      |      |      |      |      |
 157   `----------------------------------'                                       `----------------------------------'
 158                                        ,-------------.       ,-------------.
 159                                        |      |      |       |      |      |
 160                                 ,------+------+------|       |------+------+------.
 161                                 |      |      |      |       |      |      |      |
 162                                 |      |      |------|       |------|      |      |
 163                                 |      |      |      |       |      |      |      |
 164                                 `--------------------'       `--------------------'
 165 ```
 166
 167 ## Changelog
 168
 169 - 2018/03/06
 170   Add layer for user defined words (replaces `CFQ_USE_EXPEREMENTAL_LAYER`).
 171
 172   Minor changes to thumb cluster.
 173
 174   Move backspace to left thumb, optionally remap the top right backspace.
 175
 176   Make keypad layout match a typical numpad.
 177
 178   Move F-Keys to layer 3.
 179
 180 - 2017/11/09
 181   Use Caps-Lock when `CFQ_USE_EXPEREMENTAL_LAYER` isn't defined.
 182
 183 - 2017/11/07
 184   Make thumb left thumb cluster completely configurable with defines.
 185   Add mouse wheel to mouse layer.
 186
 187 - 2017/10/28
 188   Make more keys user defined on the left thumb cluster.
 189   Add macro record/replay keys.
 190
 191 - 2017/10/04
 192   Move Insert key to the left thumb cluster (away from the modifier keys).
 193   Replace with `USR2` which defaults to `APP`.