ergodox qwerty_code_friendly: add macro keys (#1918)

[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 cb5e96d69bbd088d6185e75b448521638e469053..52677310c072b78270fece2f23accf48db1c0f8c 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`, `CFQ_USER_KEY2` are used for custom-keys
+- `CFQ_USER_KEY1` (1..4) 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.
@@ -40,8 +40,10 @@ using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 
 When undefined:
 
-- `USR1` defaults to `F13`, otherwise use `CFQ_USER_KEY1`.
-- `USR2` defaults to `APP`, otherwise use `CFQ_USER_KEY2`.
+- `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`.
 
 ```
 ,--------------------------------------------------.           ,--------------------------------------------------.
@@ -53,21 +55,23 @@ When undefined:
 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  | LCtl |Super | Alt  | USR2 |Space |                                       | Left | Down | Up   |Right | Del  |
+  | LCtl |Super | Alt  | USR4 |Space |                                       | Left | Down | Up   |Right | Del  |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,-------------.
-                                       | Ins  | ~L3  |       | Home | End  |
+                                       | Ins  | USR3 |       | Home | End  |
                                 ,------|------|------|       |------+------+------.
                                 |      |      | ~L2  |       | PgUp |      |      |
-                                |Space | USR1 |------|       |------|Enter |Space |
+                                | USR1 | USR2 |------|       |------|Enter |Space |
                                 |      |      | ~L1  |       | PgDn |      |      |
                                 `--------------------'       `--------------------'
-
 ```
 
 ## Keymap 1: Symbol layer
 
-Note the double bracket keys on this layer press left to position the cursor between them.
+Notes:
+
+- The double bracket keys on this layer press left to position the cursor between them.
+- The left thumb cluster is used for macro record/replay.
 
 ```
 ,--------------------------------------------------.           ,--------------------------------------------------.
@@ -82,10 +86,10 @@ Note the double bracket keys on this layer press left to position the cursor bet
   |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,---------------.
-                                       |      |      |       |      |        |
+                                       |Start1|Start2|       |      |        |
                                 ,------|------|------|       |------+--------+------.
-                                |      |      |      |       |      |        |      |
-                                |      |      |------|       |------|        |      |
+                                |      |      | Stop |       |      |        |      |
+                                |Play1 |Play2 |------|       |------|        |      |
                                 |      |      |      |       |      |        |      |
                                 `--------------------'       `----------------------'
 ```
@@ -115,6 +119,10 @@ Note the double bracket keys on this layer press left to position the cursor bet
 
 ## Changelog
 
+- 2017/10/28
+  Make more keys user defined on the left thumb cluster.
+  Add macro record/replay keys.
+
 - 2017/10/4
   Move Insert key to the left thumb cluster (away from the modifier keys).
   Replace with `USR2` which defaults to `APP`.