diff options
Diffstat (limited to 'layouts/community/ergodox/qwerty_code_friendly/readme.md')
| -rw-r--r-- | layouts/community/ergodox/qwerty_code_friendly/readme.md | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/layouts/community/ergodox/qwerty_code_friendly/readme.md b/layouts/community/ergodox/qwerty_code_friendly/readme.md new file mode 100644 index 000000000..52a973359 --- /dev/null +++ b/layouts/community/ergodox/qwerty_code_friendly/readme.md | |||
| @@ -0,0 +1,112 @@ | |||
| 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`, `CFQ_USER_KEY2` are used for custom-keys | ||
| 31 | if not set they default to F13, F14. | ||
| 32 | - `CFQ_USE_MOMENTARY_LAYER_KEYS` is used to prevent layer keys from toggling when tapped. | ||
| 33 | - `CFQ_USE_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros. | ||
| 34 | Currently it's mostly empty. | ||
| 35 | - `CFQ_USE_SWAP_RIGHT_SPACE_ENTER` swap Enter and Space on the right hand thumb cluster. | ||
| 36 | While asymmetric, it makes Enter more easily accessible. | ||
| 37 | |||
| 38 | |||
| 39 | |||
| 40 | ## Keymap 0: Basic layer | ||
| 41 | |||
| 42 | ``` | ||
| 43 | ,--------------------------------------------------. ,--------------------------------------------------. | ||
| 44 | | Grave | ! | @ | # | $ | % | { | | } | ^ | & | * | - | = | BSpace | | ||
| 45 | |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| | ||
| 46 | | Tab | Q | W | E | R | T | ( | | ) | Y | U | I | O | P | \ | | ||
| 47 | |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| | ||
| 48 | | Esc | A | S | D | F | G |------| |------| H | J | K | L | ; | ' | | ||
| 49 | |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------| | ||
| 50 | | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift | | ||
| 51 | `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' | ||
| 52 | | LCtl |Super | Alt | Ins |Space | | Left | Down | Up |Right | Del | | ||
| 53 | `----------------------------------' `----------------------------------' | ||
| 54 | ,-------------. ,-------------. | ||
| 55 | | USR2 | ~L3 | | Home | End | | ||
| 56 | ,------|------|------| |------+------+------. | ||
| 57 | | | | ~L2 | | PgUp | | | | ||
| 58 | |Space | USR1 |------| |------|Enter |Space | | ||
| 59 | | | | ~L1 | | PgDn | | | | ||
| 60 | `--------------------' `--------------------' | ||
| 61 | |||
| 62 | ``` | ||
| 63 | |||
| 64 | ## Keymap 1: Symbol layer | ||
| 65 | |||
| 66 | Note the double bracket keys on this layer press left to position the cursor between them. | ||
| 67 | |||
| 68 | ``` | ||
| 69 | ,--------------------------------------------------. ,--------------------------------------------------. | ||
| 70 | | | F1 | F2 | F3 | F4 | F5 | {} | | }{ | F6 | F7 | F8 | F9 | F10 | | | ||
| 71 | |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| | ||
| 72 | | | | | | | => | () | | )( | <= | 7 | 8 | 9 | \ | F11 | | ||
| 73 | |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| | ||
| 74 | | | | | | | -> |------| |------| <- | 4 | 5 | 6 | * | F12 | | ||
| 75 | |--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------| | ||
| 76 | | | | | | | <> | | | | >< | 1 | 2 | 3 | - | | | ||
| 77 | `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' | ||
| 78 | | | | | | | | 0 | | . | + | | | ||
| 79 | `----------------------------------' `----------------------------------' | ||
| 80 | ,-------------. ,---------------. | ||
| 81 | | | | | | | | ||
| 82 | ,------|------|------| |------+--------+------. | ||
| 83 | | | | | | | | | | ||
| 84 | | | |------| |------| | | | ||
| 85 | | | | | | | | | | ||
| 86 | `--------------------' `----------------------' | ||
| 87 | ``` | ||
| 88 | |||
| 89 | ## Keymap 2: Media and mouse keys | ||
| 90 | |||
| 91 | ``` | ||
| 92 | ,--------------------------------------------------. ,--------------------------------------------------. | ||
| 93 | | | | | | | | | | | | | | | | | | ||
| 94 | |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| | ||
| 95 | | | | | MsUp | | | | | | | | | | | | | ||
| 96 | |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| | ||
| 97 | | | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | | | ||
| 98 | |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| | ||
| 99 | | | | Rclk | Mclk | Lclk | | | | | | | | | | | | ||
| 100 | `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' | ||
| 101 | | | | | | | | | | | | | | ||
| 102 | `----------------------------------' `----------------------------------' | ||
| 103 | ,-------------. ,-------------. | ||
| 104 | | MRwd | MFwd | | MPrv | MNxt | | ||
| 105 | ,------|------|------| |------+------+------. | ||
| 106 | | | | | |VolUp | | | | ||
| 107 | | | |------| |------| Mute | Play | | ||
| 108 | | | | | |VolDn | | | | ||
| 109 | `--------------------' `--------------------' | ||
| 110 | ``` | ||
| 111 | |||
| 112 | ## Changelog | ||
