Updated documentation ahead of reverting keymap back

This commit is contained in:
Victor 2024-05-09 10:52:35 -05:00
parent fcb238ab2f
commit 96529e5fa7
Failed to generate hash of commit
3 changed files with 19 additions and 4 deletions

View file

@ -50,7 +50,7 @@ Caps Word enables temporary all-caps typing without holding shift. Useful to typ
### Tap-Holds
Certain keys have different behaviors when held vs tapped allowing commonly typed characters or auto-shifting certain keycodes
Certain keys have different behaviors when held vs tapped allowing commonly typed programming syntax or shifting certain keycodes without actually pressing/holding shift
| Keycode | When tapped | When held | Comments |
| --------- | ----------- | ----------------------- | --------------------------------- |
@ -64,15 +64,30 @@ Certain keys have different behaviors when held vs tapped allowing commonly type
| `TR_DOT` | `.` | `)` | |
| `TR_PERC` | `%` | `^` | |
| `TR_MINS` | `-` | `_` | |
| `TR_GRV` | ` | `~` | |
| `TR_GRV` | `backtick` | `~` | |
| `TR_SCLN` | `;` | `:` | |
| `TR_QUOT` | `'` | `"` | |
| `TR_AT` | `@` | `&` | |
| `TR_EXLM` | `!` | `$` | |
Opted to implement overrides here instead of using built-in Key Override functionality because
- Not required to press/hold shift to get the alternate key
- Key Overrides would enable holding to repeat keycodes but hard to justify that for the symbols, even for programming
### Combos
Enables additional keys to be mapped by pressing multiple keys simultaneously. Primarily used to implement mouse buttons and make important keys (enter, backspace, etc) available on base layer
### Key Overrides
Primarily used to minimize the layout
| Keycode | Shift Mod Applied | Comment |
| --------- | ----------------- | -------------------------------------- |
| `KC_BSPC` | `KC_DEL` | Implemented to reduce amount of combos |
| `KC_MNXT` | `KC_MPRV` | |
### Mouse Keys
This layout is designed to be used with a Ploopy Nano. Mouse buttons and scroll wheel is handled on the keyboard side. There are macros with the host status (Caps lock, Num Lock) to toggle Ploopy Nano settings or change the tracking to simulate a scroll wheel

View file

@ -44,12 +44,12 @@ layers:
- {t: Mute, type: ghost}
SYM:
- [Esc, Mouse 3, Mouse 2, Mouse 1, {h: '~', t: '`'}, {h: '==', t: '='}, '#', {h: '<>', t: '<'}, '>', {h: '^', t: '%'}]
- [Gui, Alt, Ctrl, Shift, {h: ':', t: ';'}, {h: '&', t: '@'}, '*', {h: '[]', t: '['}, ']', {h: '''''', t: ''''}]
- [Gui, Alt, Ctrl, Shift, {h: ':', t: ';'}, {h: '&', t: '@'}, {h: '*', t: '?'}, {h: '[]', t: '['}, ']', {h: '''''', t: ''''}]
- [Undo, Cut, Copy, Paste, Redo, {h: '\\', t: "\\"}, {h: '//', t: '/'}, {h: '()', t: '('}, ')', {h: '_', t: '-'}]
- {type: ghost}
- {type: held}
- null
- null
- {h: '$', t: '!'}
- NAV
- {type: ghost}
NUM:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 133 KiB

After

Width:  |  Height:  |  Size: 133 KiB

Before After
Before After