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 (the media layer even uses arrow keys for HJKL).
   7
   8 - On the top row only symbols are used (not numbers),
   9   it's expected the symbol layer's number-pad layout will be used for numbers.
  10
  11 - Symbols match regular QWERTY.
  12   except for '()' which are grouped with other brackets.
  13   In their place -/= keys are placed, which almost matches a regular layout.
  14
  15 - Brackets are placed symmetrically along the center edges,
  16   if using keys from both sides is inconvenient - the symbol layer has macros
  17   at the same key locations to type matching pairs.
  18
  19 - The extra space-bar on the lower-left looks like it's in an obscure location,
  20   however using the larger thumb cluster ended up being more of a reach while typing.
  21
  22 - L3 is currently only used if `CFQ_USE_EXPEREMENTAL_LAYER` is defined,
  23   this is a layer to place extra functionality and test new keys.
  24
  25 ## Configuration
  26
  27 Some optional behavior is configurable without editing the code
  28 using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
  29
  30 - `CFQ_USER_KEY1` (1..7) are used for custom-keys
  31 - `CFQ_USE_MOMENTARY_LAYER_KEYS` is used to prevent layer keys from toggling when tapped.
  32 - `CFQ_USE_SWAP_RIGHT_SPACE_ENTER` swap Enter and Space on the right hand thumb cluster.
  33   While asymmetric, it makes Enter more easily accessible.
  34 - `CFQ_USE_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros.
  35   When set, Caps-Lock is replace by Layer3.
  36   Currently it's mostly empty.
  37
  38
  39
  40 ## Keymap 0: Basic layer
  41
  42 ```
  43 Keymap 0: Basic layer
  44 ,--------------------------------------------------.           ,--------------------------------------------------.
  45 | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
  46 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  47 | Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
  48 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  49 | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
  50 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
  51 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  52 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  53   | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
  54   `----------------------------------'                                       `----------------------------------'
  55                                        ,-------------.       ,-------------.
  56                                        | Ins  |CapsLk|       | Home | End  |
  57                                 ,------|------|------|       |------+------+------.
  58                                 |      |      | ~L2  |       | PgUp |      |      |
  59                                 |Space |Enter |------|       |------|Enter |Space |
  60                                 |      |      | ~L1  |       | PgDn |      |      |
  61                                 `--------------------'       `--------------------'
  62
  63 Optional overrides: see CFQ_USER_KEY# defines
  64
  65   -------+------+------+------+------+
  66   |      |      |      | USR1 |      |
  67   `----------------------------------'
  68
  69                                        ,-------------.
  70                                        | USR2 | USR3 |
  71                                 ,------|------|------|
  72                                 |      |      | USR6 |
  73                                 | USR4 | USR5 |------|
  74                                 |      |      | USR7 |
  75                                 `--------------------'
  76 ```
  77
  78 ## Keymap 1: Symbol layer
  79
  80 Notes:
  81
  82 - The double bracket keys on this layer press left to position the cursor between them.
  83 - The left thumb cluster is used for macro record/replay.
  84
  85 ```
  86 ,--------------------------------------------------.           ,--------------------------------------------------.
  87 |        |  F1  |  F2  |  F3  |  F4  |  F5  |  {}  |           |  }{  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
  88 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  89 |        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   \  |   F11  |
  90 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  91 |        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   *  |   F12  |
  92 |--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
  93 |        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  |   -  |        |
  94 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  95   |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
  96   `----------------------------------'                                       `----------------------------------'
  97                                        ,-------------.       ,---------------.
  98                                        |Start1|Start2|       |      |        |
  99                                 ,------|------|------|       |------+--------+------.
 100                                 |      |      | Stop |       |      |        |      |
 101                                 |Play1 |Play2 |------|       |------|        |      |
 102                                 |      |      |      |       |      |        |      |
 103                                 `--------------------'       `----------------------'
 104 ```
 105
 106 ## Keymap 2: Media and mouse keys
 107
 108 ```
 109 ,--------------------------------------------------.           ,--------------------------------------------------.
 110 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 111 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 112 |        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
 113 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 114 |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
 115 |--------+------+------+------+------+------|MWhlDn|           |      |------+------+------+------+------+--------|
 116 |        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
 117 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 118   |      |      |      |      |      |                                       |      |      |      |      |      |
 119   `----------------------------------'                                       `----------------------------------'
 120                                        ,-------------.       ,-------------.
 121                                        | MRwd | MFwd |       | MPrv | MNxt |
 122                                 ,------|------|------|       |------+------+------.
 123                                 |      |      |      |       |VolUp |      |      |
 124                                 |      |      |------|       |------| Mute | Play |
 125                                 |      |      |      |       |VolDn |      |      |
 126                                 `--------------------'       `--------------------'
 127 ```
 128
 129 ## Changelog
 130
 131 - 2017/11/09
 132   Use Caps-Lock when `CFQ_USE_EXPEREMENTAL_LAYER` isn't defined.
 133
 134 - 2017/11/07
 135   Make thumb left thumb cluster completely configurable with defines.
 136   Add mouse wheel to mouse layer.
 137
 138 - 2017/10/28
 139   Make more keys user defined on the left thumb cluster.
 140   Add macro record/replay keys.
 141
 142 - 2017/10/04
 143   Move Insert key to the left thumb cluster (away from the modifier keys).
 144   Replace with `USR2` which defaults to `APP`.