diff options
| author | yttyx <yttyx@users.noreply.github.com> | 2020-05-26 05:24:16 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-25 21:24:16 -0700 |
| commit | bfe76053ba2767e8df1aea1183c8dcaabeaca8c9 (patch) | |
| tree | 2b13dbb7f332a383c3fe52747bbd9f503072a093 /keyboards/niu_mini/keymaps/yttyx/README.md | |
| parent | 9d41281a1d09c8bd3ae1c0a8bd6df95ada899451 (diff) | |
| download | firmware-bfe76053ba2767e8df1aea1183c8dcaabeaca8c9.tar.gz firmware-bfe76053ba2767e8df1aea1183c8dcaabeaca8c9.tar.bz2 firmware-bfe76053ba2767e8df1aea1183c8dcaabeaca8c9.zip | |
[Keymap] Niu keymap and README update (#9190)
* - Balance 12 layers now in their final form
- Added Plover layer
- Updated README to use layout images
* Add headings to layer images.
* - Remove redundent TO(_BA) from FC layer
- Link to new FC layer image from README
* Highlight home keys.
* Changes following review.
Diffstat (limited to 'keyboards/niu_mini/keymaps/yttyx/README.md')
| -rw-r--r-- | keyboards/niu_mini/keymaps/yttyx/README.md | 80 |
1 files changed, 10 insertions, 70 deletions
diff --git a/keyboards/niu_mini/keymaps/yttyx/README.md b/keyboards/niu_mini/keymaps/yttyx/README.md index a48bdcca3..ff3937c23 100644 --- a/keyboards/niu_mini/keymaps/yttyx/README.md +++ b/keyboards/niu_mini/keymaps/yttyx/README.md @@ -1,7 +1,7 @@ # Overview -This layout is based on Balance Twelve (mirror variant) by Sasha Viminitz. Please see [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/) -for more information. It's designed for left-handers who use their right hand for the mouse. +This layout uses a mirror variant of Balance 12, created by Sasha Viminitz. See [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/) +for more information. ## To build @@ -19,74 +19,14 @@ sudo dfu-programmer atmega32u4 launch ## Layers -### Base: +### Balance 12 base (BA) layer + - .--------.-------.-------.-------.--------. .-------.-------.-------.-------.------. - | P | L | C | D | W | | U | O | Y | K | Q | - |--------+-------+-------+-------+--------| |-------+-------+-------+-------+------| - | N | R | S | T | M | | A | E | I | H | V | - |--------+-------+-------+-------+--------| |-------+-------+-------+-------+------| - | Z Sft | J Ctl | F Alt | G | B | | , | . Alt | ; Ctl | X Sft | Sup | - '--------'-------'-------+-------+--------+-----. .-----+-------+-------+-------'-------'------' - | BS P1 | Spc P2 | P3 | | | Sft | | - '-------'--------'-----' '-----'-------'-------' +### Numeric/Punctuation (NP) layer + -### P1: Punctuation (1) +### Function/Cursor (FC) layer + - .--------.-------.-------.-------.-------. .------.-------.-------.-------.------. - | Esc | | | | | | | | / | ^ | £ | ~ | - |--------+-------+-------+-------+-------| |------+-------+-------+-------+------| - | Tab | | | | | | & | \ | ` | $ | Ent | - |--------+-------+-------+-------+-------| |------+-------+-------+-------+------| - | Sft | Ctl | Alt | Del | | | % | Alt | Ctl | Sft | Sup | - '--------'-------'-------+-------+-------+-----. .-----+------+-------+-------'-------'------' - | P1 | | | | | Sft | | - '-------'-------'-----' '-----'------'-------' - -### P2: Punctuation (2) - - .-------.-------.-------.-------.-------. .-------.-------.-------.-------.------. - | Esc | | NC | FV | | | ( | ) | " | ? | | - |-------+-------+-------+-------+-------| |-------+-------+-------+-------+------| - | Tab | Ctl-X | Ctl-C | Ctl-V | Ctl-Z | | { | } | ' | ! | Ent | - |-------+-------+-------+-------+-------| |-------+-------+-------+-------+------| - | Sft | Ctl | Alt | Del | Ent | | # | Alt | Ctl | Sft | Sup | - '-------'-------'-------+-------+-------+-----. .-----+-------+-------+-------'-------'------' - | BS | P2 | | | | Sft | | - '-------'-------'-----' '-----'-------'-------' - -### P3: Punctuation (3) - - .-------.-------.-------.-------.-------. .------.-------.-------.-------.------. - | Esc | | Break | Pscr | ScLk | | < | > | + | _ | = | - |-------+-------+-------+-------+-------| |------+-------+-------+-------+------| - | Tab | | | Caps | | | [ | ] | * | - | Ent | - |-------+-------+-------+-------+-------| |------+-------+-------+-------+------| - | Sft | Ctl | Alt | Del | | | @ | Alt | Ctl | Sft | Sup | - '-------'-------'-------+-------+-------+-----. .-----+------+-------+-------'-------'------' - | BS | | P3 | | | Sft | | - '-------'-------'-----' '-----'------'-------' - -### Numerals / Cursor control - - .-------.-------.-------.------.-------. .------.-------.-------.------.------. - | 1 | 2 | 3 | 4 | 5 | | Home | Up | End | PgUp | | - |-------+-------+-------+------+-------| |------+-------+-------+------+------| - | 6 | 7 | 8 | 9 | 0 | | Left | Down | Right | PgDn | | - |-------+-------+-------+------+-------| |------+-------+-------+------+------| - | Sft | Ctl | Alt | Del | . | | Ins | Alt | Ctl | Sft | Sup | - '-------'-------'-------+------+-------+-----. .-----+------+-------+-------'------'------' - | BS | BA | | | | Sft | | - '------'-------'-----' '-----'------'-------' - -### FV: Function keys / Cursor control (Vim) - - .-------.------.-------.-----.-------. .------.-------.-----.-------.------. - | F1 | F2 | F3 | F4 | F5 | | 0 | K | $ | Ctl-B | | - |-------+------+-------+-----+-------| |------+-------+-----+-------+------| - | F6 | F7 | F8 | F9 | F10 | | H | J | L | Ctl-F | | - |-------+------+-------+-----+-------| |------+-------+-----+-------+------| - | Sft | Ctl | Alt | F11 | F12 | | | Alt | Ctl | Sft | Sup | - '-------'------'-------+-----+-------+-----. .-----+------+-------+-----'-------'------' - | BS | BA | | | | Sft | | - '-----'-------'-----' '-----'------'-------' +### Plover (PL) layer + |