qwerty_code_friendly: configurable left thumb

[qmk_firmware.git] / layouts / community / ergodox / qwerty_code_friendly / readme.md

diff --git a/layouts/community/ergodox/qwerty_code_friendly/readme.md b/layouts/community/ergodox/qwerty_code_friendly/readme.md
index 52677310c072b78270fece2f23accf48db1c0f8c..6153fb259233a22b1ab962092ca40d376bb21c18 100644 (file)
--- a/layouts/community/ergodox/qwerty_code_friendly/readme.md
+++ b/layouts/community/ergodox/qwerty_code_friendly/readme.md
@@ -27,7 +27,7 @@
 Some optional behavior is configurable without editing the code
 using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 
-- `CFQ_USER_KEY1` (1..4) are used for custom-keys
+- `CFQ_USER_KEY1` (1..7) are used for custom-keys
 - `CFQ_USE_MOMENTARY_LAYER_KEYS` is used to prevent layer keys from toggling when tapped.
 - `CFQ_USE_SWAP_RIGHT_SPACE_ENTER` swap Enter and Space on the right hand thumb cluster.
   While asymmetric, it makes Enter more easily accessible.
@@ -38,14 +38,8 @@ using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 
 ## Keymap 0: Basic layer
 
-When undefined:
-
-- `USR1` defaults to `KC_SPC`, otherwise use `CFQ_USER_KEY1`.
-- `USR2` defaults to `KC_ENT`, otherwise use `CFQ_USER_KEY2`.
-- `USR3` defaults to `KC_FN3`, otherwise use `CFQ_USER_KEY3`.
-- `USR4` defaults to `APP`, otherwise use `CFQ_USER_KEY4`.
-
 ```
+Keymap 0: Basic layer
 ,--------------------------------------------------.           ,--------------------------------------------------.
 | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
@@ -55,15 +49,29 @@ When undefined:
 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  | LCtl |Super | Alt  | USR4 |Space |                                       | Left | Down | Up   |Right | Del  |
+  | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,-------------.
-                                       | Ins  | USR3 |       | Home | End  |
+                                       | Ins  | ~L3  |       | Home | End  |
                                 ,------|------|------|       |------+------+------.
                                 |      |      | ~L2  |       | PgUp |      |      |
-                                | USR1 | USR2 |------|       |------|Enter |Space |
+                                |Space |Enter |------|       |------|Enter |Space |
                                 |      |      | ~L1  |       | PgDn |      |      |
                                 `--------------------'       `--------------------'
+
+Optional overrides: see CFQ_USER_KEY# defines
+
+  -------+------+------+------+------+
+  |      |      |      | USR1 |      |
+  `----------------------------------'
+
+                                       ,-------------.
+                                       | USR2 | USR3 |
+                                ,------|------|------|
+                                |      |      | USR6 |
+                                | USR4 | USR5 |------|
+                                |      |      | USR7 |
+                                `--------------------'
 ```
 
 ## Keymap 1: Symbol layer
@@ -100,10 +108,10 @@ Notes:
 ,--------------------------------------------------.           ,--------------------------------------------------.
 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
-|        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
+|        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|--------+------+------+------+------+------|MWhlDn|           |      |------+------+------+------+------+--------|
 |        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
   |      |      |      |      |      |                                       |      |      |      |      |      |
@@ -119,10 +127,14 @@ Notes:
 
 ## Changelog
 
+- 2017/11/07
+  Make thumb left thumb cluster completely configurable with defines.
+  Add mouse wheel to mouse layer.
+
 - 2017/10/28
   Make more keys user defined on the left thumb cluster.
   Add macro record/replay keys.
 
-- 2017/10/4
+- 2017/10/04
   Move Insert key to the left thumb cluster (away from the modifier keys).
   Replace with `USR2` which defaults to `APP`.