aboutsummaryrefslogtreecommitdiffstats
path: root/users/alfrdmalr/readme.md
diff options
context:
space:
mode:
authorAlfred Maler <alfrdmalr@gmail.com>2020-03-03 13:13:42 -0500
committerGitHub <noreply@github.com>2020-03-03 10:13:42 -0800
commited6586e25bd854f445193566150439b25853f831 (patch)
tree19e1b0973782f7d11eab0c85f7ab3e54e540b390 /users/alfrdmalr/readme.md
parentacaecb4f94e3f1dc45cce53b10d1b89052b25ca7 (diff)
downloadfirmware-ed6586e25bd854f445193566150439b25853f831.tar.gz
firmware-ed6586e25bd854f445193566150439b25853f831.tar.bz2
firmware-ed6586e25bd854f445193566150439b25853f831.zip
[Keymap] Feature/alfrdmalr/keymap update (#8174)
* WIP do not merge * first pass at custom preonic layout * add auto shift and reset via leader key * Update readme * update copyright notice * formatting changes * fix: use MO instead of process_record_user * added backslash and moved grave position * remove extraneous 'j' characer in NUMPAD template * update template formatting * remove process_record_user * swap "!" with "@" * fix readme formatting * update readme layout image * restore settings layer * add windows minimize sequence * fix: switch to correct seq function for three-key sequence * fix: missing semicolon * refactor: move keymap to userspace and generic 5x12 layout * add numlock to numpad layer * add readme * update readme formatting * remove unused wrappers from layout keymap * update readme title to reflect new location * remove alfrdmalr directory from preonic/keymaps * add ortho 4x12 support * add 'trilayer' settings and update keymap * update SYMBOLS layer to SYMBOL * remove minimize sequence * clean up user config * add brightness controls * update settings ascii * moved some symbols around to make vim/linux smoother
Diffstat (limited to 'users/alfrdmalr/readme.md')
-rw-r--r--users/alfrdmalr/readme.md23
1 files changed, 11 insertions, 12 deletions
diff --git a/users/alfrdmalr/readme.md b/users/alfrdmalr/readme.md
index d462a5baf..9e5f962bb 100644
--- a/users/alfrdmalr/readme.md
+++ b/users/alfrdmalr/readme.md
@@ -1,6 +1,6 @@
# alfrdmalr's userspace
## Overview
-The alphanumeric characters and symbols are spread between three main 'typing' layers: REGULAR, NUMPAD, and SYMBOLS.
+The alphanumeric characters and symbols are spread between three main 'typing' layers: REGULAR, NUMPAD, and SYMBOL.
A fourth layer, NAVIGATION, contains useful modifiers, shortcuts, and navigation functions like the arrow keys and page up/down. This layer also provides access to the `ENTER` and `ESC` keys.
@@ -22,26 +22,25 @@ The NUMPAD layer puts a numpad under the right hand, surrounding the home row po
This layer also holds the first twelve function keys.
-#### SYMBOLS
-This layer holds all the symbols that are not accessible from the REGULAR layer. There is some redundancy (for instance, `/` exists in both the REGULAR and SYMBOLS layer; its position, however, remains consistent) but with the exception of single and double quotes, all symbols are available from this layer.
+#### SYMBOL
+This layer holds all the symbols that are not accessible from the REGULAR layer. There is some redundancy (for instance, `/` exists in both the REGULAR and SYMBOL layer; its position, however, remains consistent) but with the exception of single and double quotes, all symbols are available from this layer.
#### NAVIGATION
-The primary function of this layer is to provide arrow keys under hjkl. The surrounding keys contain similar functionality - for instance, the keys directly below `DOWN` and `UP` are `PAGEDOWN` and `PAGEUP`, respectively. `HOME` and `END` are inverted from this convention, simply because I kept hitting the wrong key when trying to jump to the beginning/end of lines when editing text.
+Over time, this layer has become a general utility layer, though its primary function of is still to provide arrow keys under hjkl. The surrounding keys contain similar functionality - for instance, the keys directly below `DOWN` and `UP` are `PAGEDOWN` and `PAGEUP`, respectively. `HOME` and `END` are inverted from this convention, simply because I kept hitting the wrong key when trying to jump to the beginning/end of lines when editing text.
To the immediate right of the NAVIGATION layer key are the following modifiers: `SHIFT`, `CONTROL`, `ALT`, `GUI`. All modifiers are the "left" variants. The idea is to use the left hand to hold different modifiers as necessary while using the right hand to navigate and format.
-`ESCAPE` is located on the spacebar from this layer, and `DELETE` is placed next to `BACKSPACE`, for convenience when formatting text. There are also four Windows shortcuts for undo, cut, copy, and paste, located in the same position as the relevant keys on the base layer (undo, for example, is in the same place as the `Z` key).
+`ESCAPE` is located on the spacebar from this layer, and `DELETE` is placed next to `BACKSPACE`, for convenience when formatting text. There are also four Windows shortcuts for undo, cut, copy, and paste, located in the same position as the relevant keys on the base layer (undo, for example, is in the same place as the `Z` key). Again, this is for convenience when formatting text.
#### SETTINGS
-Right now, this is pretty similar to the default settings layer (the planck's ADJUST layer).
+The SETTINGS layer can be accessed by pressing both SYMBOL layer keys at once. This is functionally the same as a trilayer, though because both keys are activating the same layer it doesn't actually use the trilayer feature.
-Primary differences are the inclusion of an autoshift toggle and the removal of the reset button. The bootloader functionality has been moved to a leader key sequence: LEAD - R - E - S - E - T.
+This layer contains things like feature toggles, media controls, and other infrequently-used options.
### Leader Key Sequences
-A complete list of leader sequences can be found below:
+A complete list of leader sequences can be found below. The LEAD key that begins each sequence has been omitted.
-#### Reset
-LEAD - R - E - S - E - T
-#### Minimize (Windows)
-LEAD - M - I - N
+| Sequence | Function |
+| :------: | -------------------------------- |
+| R-E-S-E-T | Reset the keyboard into DFU mode |