X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=layouts%2Fcommunity%2Fergodox%2Fqwerty_code_friendly%2Freadme.md;h=8bc15dd310f1b239195f9c1c3b45475d2b525465;hb=998ddbb122c9d3e2a77bd4e88c881b225ca0d569;hp=6153fb259233a22b1ab962092ca40d376bb21c18;hpb=aee67854769feee7e94edd90686178d89946a7ee;p=qmk_firmware.git diff --git a/layouts/community/ergodox/qwerty_code_friendly/readme.md b/layouts/community/ergodox/qwerty_code_friendly/readme.md index 6153fb259..8bc15dd31 100644 --- a/layouts/community/ergodox/qwerty_code_friendly/readme.md +++ b/layouts/community/ergodox/qwerty_code_friendly/readme.md @@ -3,7 +3,11 @@ - This layout aims to balance muscle memory from a typical QWERTY layout with having keys used for software development easily accessible. -- Arrow keys follow VIM convention (the media layer even uses arrow keys for HJKL). + The this layout is a normalized qwerty, + with some configurable keys left thumb cluster so you can use it more as needed. + +- Arrow keys follow VIM convention + (the media layer even uses arrow keys for HJKL). - On the top row only symbols are used (not numbers), it's expected the symbol layer's number-pad layout will be used for numbers. @@ -16,65 +20,81 @@ if using keys from both sides is inconvenient - the symbol layer has macros at the same key locations to type matching pairs. -- The extra space-bar on the lower-left looks like it's in an obscure location, - however using the larger thumb cluster ended up being more of a reach while typing. - -- L3 is currently only used if `CFQ_USE_EXPEREMENTAL_LAYER` is defined, - this is a layer to place extra functionality and test new keys. +- The space-bar on the lower-left looks like it's in an obscure location, + however using the larger thumb cluster + ended up being more of a reach while typing. ## Configuration 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..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. -- `CFQ_USE_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros. - Currently it's mostly empty. +- `CFQ_USER_KEY0` + (0..7) are used for custom-keys +- `CFQ_USE_MOMENTARY_LAYER_KEYS` + is used to prevent layer keys from toggling when tapped. +- `CFQ_USE_SHIFT_QUOTES` + an optional handy shortcut for writing quotes that inserts the + cursor between the quotation marks. + + Holding LShift, then RShift types: "" (then presses left). + Holding RShift, then LShift types: '' (then presses left). + +- `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 ``` -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 | ~L3 | | Home | End | - ,------|------|------| |------+------+------. - | | | ~L2 | | PgUp | | | - |Space |Enter |------| |------|Enter |Space | - | | | ~L1 | | PgDn | | | - `--------------------' `--------------------' - -Optional overrides: see CFQ_USER_KEY# defines - - -------+------+------+------+------+ - | | | | USR1 | | - `----------------------------------' - - ,-------------. - | USR2 | USR3 | - ,------|------|------| - | | | USR6 | - | USR4 | USR5 |------| - | | | USR7 | - `--------------------' +.--------------------------------------------------. .--------------------------------------------------. +| 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 | | | | | + '--------------------' '--------------------' ``` -## Keymap 1: Symbol layer +## Keymap 1: KeyPad, Macro Record Notes: @@ -82,51 +102,113 @@ Notes: - The left thumb cluster is used for macro record/replay. ``` -,--------------------------------------------------. ,--------------------------------------------------. -| | F1 | F2 | F3 | F4 | F5 | {} | | }{ | F6 | F7 | F8 | F9 | F10 | | -|--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| -| | | | | | => | () | | )( | <= | 7 | 8 | 9 | \ | F11 | -|--------+------+------+------+------+------| | | |------+------+------+------+------+--------| -| | | | | | -> |------| |------| <- | 4 | 5 | 6 | * | F12 | -|--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------| -| | | | | | <> | | | | >< | 1 | 2 | 3 | - | | -`--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' - | | | | | | | 0 | | . | + | | - `----------------------------------' `----------------------------------' - ,-------------. ,---------------. - |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: Media, Mouse Keys and Numbers + +Notes: + +- Numbers are included on this layer since some applications differentiate + between numbers top row and keypad. + +``` +.--------------------------------------------------. .--------------------------------------------------. +| | 1 | 2 | 3 | 4 | 5 | | | Mute | 6 | 7 | 8 | 9 | 0 | | +|--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------| +| | | | MsUp | | |MWhlUp| |VolUp | | | | | | | +|--------+------+------+------+------+------| | | |------+------+------+------+------+--------| +| | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | | +|--------+------+------+------+------+------|MWhlDn| |VolDn |------+------+------+------+------+--------| +| | | Rclk | Mclk | Lclk | | | | | | | | | | | +'--------+------+------+------+------+-------------' '-------------+------+------+------+------+--------' + | | | | | | | | | | | | + '----------------------------------' '----------------------------------' + .-------------. .-------------. + | | | | MRwd | MFwd | + .------+------+------| |------+------+------. + | | | | | MPrv | | | + | | |------| |------| | Play | + | | | | | MNxt | | | + '--------------------' '--------------------' ``` -## Keymap 2: Media and mouse keys +## Keymap 3: F-Keys & User Defined Words + +This is for assigning whole words to single keys. +You can define the arguments (which must be quoted) using: `CFQ_WORD_[A-Z]` +eg: `-DCFQ_WORD_E=\"my@email.com\"` ``` -,--------------------------------------------------. ,--------------------------------------------------. -| | | | | | | | | | | | | | | | -|--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| -| | | | MsUp | | |MWhlUp| | | | | | | | | -|--------+------+------+------+------+------| | | |------+------+------+------+------+--------| -| | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | | -|--------+------+------+------+------+------|MWhlDn| | |------+------+------+------+------+--------| -| | | Rclk | Mclk | Lclk | | | | | | | | | | | -`--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' - | | | | | | | | | | | | - `----------------------------------' `----------------------------------' - ,-------------. ,-------------. - | MRwd | MFwd | | MPrv | MNxt | - ,------|------|------| |------+------+------. - | | | | |VolUp | | | - | | |------| |------| Mute | Play | - | | | | |VolDn | | | - `--------------------' `--------------------' +.--------------------------------------------------. .--------------------------------------------------. +| | 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/05/29 + Add number keys for cases when keypad numbers are handled differently. + +- 2018/05/19 + Move all media keys to right thumb cluster + (matching page up/down, home/end locations). + +- 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. + + When holding shift `CFQ_WORD_[A-Z]` use title caps. + +- 2018/03/06 + Add layer for user defined words (replaces `CFQ_USE_EXPEREMENTAL_LAYER`). + + Minor changes to thumb cluster. + + Move backspace to left thumb, optionally remap the top right backspace. + + Make keypad layout match a typical numpad. + + Move F-Keys to layer 3. + +- 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.