qwerty_code_friendly: Expose caps-lock & fix typo

[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 52a97335993804c5cf223962d814d1ecbb801ab9..92130c6fb63c25b863e21c58ce93f418034881b4 100644 (file)
--- a/layouts/community/ergodox/qwerty_code_friendly/readme.md
+++ b/layouts/community/ergodox/qwerty_code_friendly/readme.md
@@ -27,19 +27,20 @@
 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
-  if not set they default to F13, F14.
+- `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_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros.
-  Currently it's mostly empty.
 - `CFQ_USE_SWAP_RIGHT_SPACE_ENTER` swap Enter and Space on the right hand thumb cluster.
   While asymmetric, it makes Enter more easily accessible.
+- `CFQ_USE_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros.
+  When set, Caps-Lock is replace by Layer3.
+  Currently it's mostly empty.
 
 
 
 ## Keymap 0: Basic layer
 
 ```
+Keymap 0: Basic layer
 ,--------------------------------------------------.           ,--------------------------------------------------.
 | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
@@ -49,21 +50,37 @@ using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  | LCtl |Super | Alt  | Ins  |Space |                                       | Left | Down | Up   |Right | Del  |
+  | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,-------------.
-                                       | USR2 | ~L3  |       | Home | End  |
+                                       | Ins  |CapsLk|       | Home | End  |
                                 ,------|------|------|       |------+------+------.
                                 |      |      | ~L2  |       | PgUp |      |      |
-                                |Space | USR1 |------|       |------|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
 
-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.
 
 ```
 ,--------------------------------------------------.           ,--------------------------------------------------.
@@ -78,10 +95,10 @@ Note the double bracket keys on this layer press left to position the cursor bet
   |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,---------------.
-                                       |      |      |       |      |        |
+                                       |Start1|Start2|       |      |        |
                                 ,------|------|------|       |------+--------+------.
-                                |      |      |      |       |      |        |      |
-                                |      |      |------|       |------|        |      |
+                                |      |      | Stop |       |      |        |      |
+                                |Play1 |Play2 |------|       |------|        |      |
                                 |      |      |      |       |      |        |      |
                                 `--------------------'       `----------------------'
 ```
@@ -92,10 +109,10 @@ Note the double bracket keys on this layer press left to position the cursor bet
 ,--------------------------------------------------.           ,--------------------------------------------------.
 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
-|        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
+|        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|--------+------+------+------+------+------|MWhlDn|           |      |------+------+------+------+------+--------|
 |        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
   |      |      |      |      |      |                                       |      |      |      |      |      |
@@ -110,3 +127,18 @@ Note the double bracket keys on this layer press left to position the cursor bet
 ```
 
 ## Changelog
+
+- 2017/11/09
+  Use Caps-Lock when `CFQ_USE_EXPEREMENTAL_LAYER` isn't defined.
+
+- 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/04
+  Move Insert key to the left thumb cluster (away from the modifier keys).
+  Replace with `USR2` which defaults to `APP`.