qwerty_code_friendly: optional 80 key layout (#2745)

[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 29a04e68931f14068f70c90de1fe5690ec68accf..d800a0a022c832b538613be0ee0fa7ca38ecc161 100644 (file)
--- a/layouts/community/ergodox/qwerty_code_friendly/readme.md
+++ b/layouts/community/ergodox/qwerty_code_friendly/readme.md
@@ -44,50 +44,54 @@ using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 - `CFQ_WORD_[A-Z]`
   defines can bind a key to an entire user defined word.
 
+- `CFQ_USE_80_KEYS`
+  enables 80 key layout, none of the extra keys are bound,
+  they need to be set with defines: `CFQ_USER_K80_L0K0` .. `CFQ_USER_K80_L3K4`.
+  Where `L#` is the layer and `K#` is the key.
 
 
 ## Keymap 0: Basic layer
 
 ```
-,--------------------------------------------------.           ,--------------------------------------------------.
-| Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
-|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-| Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-| Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
-|--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
-| LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
-`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
-  `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,-------------.
-                                       | Ins  |NumClk|       | Home | End  |
-                                ,------+------+------|       |------+------+------.
-                                |      |      |CapsLk|       | PgUp |      |      |
-                                |BSpace| Del  |------|       |------| ~L2  |Enter |
-                                |      |      | ~L3  |       | PgDn |      |      |
-                                `--------------------'       `--------------------'
+.--------------------------------------------------.  .--------------------------------------------------.
+| Grave  |   !  |   @  |   #  |   $  |   %  |   {  |  |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
+|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
+| Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |  |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+| Esc    |   A  |   S  |   D  |   F  |   G  |------|  |------|   H  |   J  |   K  |   L  |   ;  |   '    |
+|--------+------+------+------+------+------|   [  |  |  ]   |------+------+------+------+------+--------|
+| LShift |   Z  |   X  |   C  |   V  |   B  |      |  |      |   N  |   M  |   ,  |   .  |   /  | RShift |
+'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
+  | LCtl |Super | Alt  | ~L1  |Space |                              | Left | Down | Up   |Right | Del  |
+  '----------------------------------'                              '----------------------------------'
+                                     .-------------.  .-------------.
+                                     | Ins  |NumClk|  | Home | End  |
+                              .------+------+------|  |------+------+------.
+                              |      |      |CapsLk|  | PgUp |      |      |
+                              |BSpace| Del  |------|  |------| ~L2  |Enter |
+                              |      |      | ~L3  |  | PgDn |      |      |
+                              '--------------------'  '--------------------'
 
 Optional overrides: see CFQ_USER_KEY# defines.
 
-,--------------------------------------------------.           ,--------------------------------------------------.
-|        |      |      |      |      |      |      |           |      |      |      |      |      |      | USR0   |
-|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-|        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  |      |      |      | USR1 |      |                                       |      |      |      |      | USR8 |
-  `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,-------------.
-                                       | USR2 | USR3 |       |      |      |
-                                ,------+------+------|       |------+------+------.
-                                |      |      | USR6 |       |      |      |      |
-                                | USR4 | USR5 |------|       |------|      |      |
-                                |      |      | USR7 |       |      |      |      |
-                                `--------------------'       `--------------------'
+.--------------------------------------------------.  .--------------------------------------------------.
+|        |      |      |      |      |      |      |  |      |      |      |      |      |      | USR0   |
+|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
+|        |      |      |      |      |      |      |  |      |      |      |      |      |      |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |      |      |      |      |      |------|  |------|      |      |      |      |      |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |      |      |      |      |      |      |  |      |      |      |      |      |      |        |
+'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
+  |      |      |      | USR1 |      |                              |      |      |      |      | USR8 |
+  '----------------------------------'                              '----------------------------------'
+                                     .-------------.  .-------------.
+                                     | USR2 | USR3 |  |      |      |
+                              .------+------+------|  |------+------+------.
+                              |      |      | USR6 |  |      |      |      |
+                              | USR4 | USR5 |------|  |------|      |      |
+                              |      |      | USR7 |  |      |      |      |
+                              '--------------------'  '--------------------'
 ```
 
 ## Keymap 1: KeyPad, Macro Record
@@ -98,47 +102,47 @@ Notes:
 - The left thumb cluster is used for macro record/replay.
 
 ```
-,--------------------------------------------------.           ,--------------------------------------------------.
-|        |      |      |      |      |      |  {}  |           |  }{  |      |NumLck|   /  |   *  |   -  |        |
-|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-|        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   +  |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   +  |        |
-|--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
-|        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  | Enter|        |
-`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  |      |      |      |      |      |                                       |   0  |      |   .  | Enter|      |
-  `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,--------------.
-                                       |Start1|Start2|       |      |       |
-                                ,------+------+------|       |------+-------+------.
-                                |      |      | Stop |       |      |       |      |
-                                |Play1 |Play2 |------|       |------|       |      |
-                                |      |      |      |       |      |       |      |
-                                `--------------------'       `---------------------'
+.--------------------------------------------------.  .--------------------------------------------------.
+|        |      |      |      |      |      |  {}  |  |  }{  |      |NumLck|   /  |   *  |   -  |        |
+|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
+|        |      |      |      |      |  =>  |  ()  |  |  )(  |  <=  |   7  |   8  |   9  |   +  |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |      |      |      |      |  ->  |------|  |------|  <-  |   4  |   5  |   6  |   +  |        |
+|--------+------+------+------+------+------|  []  |  |  ][  |------+------+------+------+------+--------|
+|        |      |      |      |      |  <>  |      |  |      |  ><  |   1  |   2  |   3  | Enter|        |
+'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
+  |      |      |      |      |      |                              |   0  |      |   .  | Enter|      |
+  '----------------------------------'                              '----------------------------------'
+                                     .-------------.  .-------------.
+                                     |Start1|Start2|  |      |      |
+                              .------+------+------|  |------+------+------.
+                              |      |      | Stop |  |      |      |      |
+                              |Play1 |Play2 |------|  |------|      |      |
+                              |      |      |      |  |      |      |      |
+                              '--------------------'  '--------------------'
 ```
 
 ## Keymap 2: Keymap 2: Media and mouse keys
 
 ```
-,--------------------------------------------------.           ,--------------------------------------------------.
-|        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-|        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
-|--------+------+------+------+------+------|MWhlDn|           |      |------+------+------+------+------+--------|
-|        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
-`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  |      |      |      |      |      |                                       |      |      |      |      |      |
-  `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,-------------.
-                                       | MRwd | MFwd |       | MPrv | MNxt |
-                                ,------+------+------|       |------+------+------.
-                                |      |      |      |       |VolUp |      |      |
-                                | Mute |      |------|       |------|      | Play |
-                                |      |      |      |       |VolDn |      |      |
-                                `--------------------'       `--------------------'
+.--------------------------------------------------.  .--------------------------------------------------.
+|        |      |      |      |      |      |      |  |      |      |      |      |      |      |        |
+|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
+|        |      |      | MsUp |      |      |MWhlUp|  |      |      |      |      |      |      |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |      |MsLeft|MsDown|MsRght|      |------|  |------| Left | Down | Up   |Right |      |        |
+|--------+------+------+------+------+------|MWhlDn|  |      |------+------+------+------+------+--------|
+|        |      | Rclk | Mclk | Lclk |      |      |  |      |      |      |      |      |      |        |
+'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
+  |      |      |      |      |      |                              |      |      |      |      |      |
+  '----------------------------------'                              '----------------------------------'
+                                     .-------------.  .-------------.
+                                     | MRwd | MFwd |  | MPrv | MNxt |
+                              .------+------+------|  |------+------+------.
+                              |      |      |      |  |VolUp |      |      |
+                              | Mute |      |------|  |------|      | Play |
+                              |      |      |      |  |VolDn |      |      |
+                              '--------------------'  '--------------------'
 ```
 
 ## Keymap 3: K-Keys & User defined words
@@ -148,28 +152,31 @@ You can define the arguments (which must be quoted) using: `CFQ_WORD_[A-Z]`
 eg: `-DCFQ_WORD_E=\"my@email.com\"`
 
 ```
-,--------------------------------------------------.           ,--------------------------------------------------.
-|        |  F1  |  F2  |  F3  |  F4  |  F5  |  F11 |           | F12  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
-|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-|        |   Q  |   W  |   E  |   R  |   T  |      |           |      |   Y  |   U  |   I  |   O  |   P  |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |      |        |
-|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |      |      |      |        |
-`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  |      |      |      |      |      |                                       |      |      |      |      |      |
-  `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,-------------.
-                                       |      |      |       |      |      |
-                                ,------+------+------|       |------+------+------.
-                                |      |      |      |       |      |      |      |
-                                |      |      |------|       |------|      |      |
-                                |      |      |      |       |      |      |      |
-                                `--------------------'       `--------------------'
+.--------------------------------------------------.  .--------------------------------------------------.
+|        |  F1  |  F2  |  F3  |  F4  |  F5  |  F11 |  | F12  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
+|--------+------+------+------+------+------+------|  |------+------+------+------+------+------+--------|
+|        |   Q  |   W  |   E  |   R  |   T  |      |  |      |   Y  |   U  |   I  |   O  |   P  |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |   A  |   S  |   D  |   F  |   G  |------|  |------|   H  |   J  |   K  |   L  |      |        |
+|--------+------+------+------+------+------|      |  |      |------+------+------+------+------+--------|
+|        |   Z  |   X  |   C  |   V  |   B  |      |  |      |   N  |   M  |      |      |      |        |
+'--------+------+------+------+------+-------------'  '-------------+------+------+------+------+--------'
+  |      |      |      |      |      |                              |      |      |      |      |      |
+  '----------------------------------'                              '----------------------------------'
+                                     .-------------.  .-------------.
+                                     |      |      |  |      |      |
+                              .------+------+------|  |------+------+------.
+                              |      |      |      |  |      |      |      |
+                              |      |      |------|  |------|      |      |
+                              |      |      |      |  |      |      |      |
+                              '--------------------'  '--------------------'
 ```
 
 ## Changelog
 
+- 2018/04/14
+  Add `CFQ_USE_80_KEYS` to optionally support an 80 key layout.
+
 - 2018/03/08
   Add `CFQ_USE_SHIFT_QUOTES` option.
   Add `CFQ_USER_KEY8` key.