Skip to content

Commit

Permalink
[Keymap] Niu keymap and README update (qmk#9190)
Browse files Browse the repository at this point in the history 
* - 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.
  • Loading branch information
@yttyx @sjmacneil
yttyx authored and sjmacneil committed Jan 27, 2021
1 parent b31cee6 commit 54f104e
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 191 deletions.
80 changes: 10 additions & 70 deletions keyboards/niu_mini/keymaps/yttyx/README.md
View file
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -19,74 +19,14 @@ sudo dfu-programmer atmega32u4 launch

## Layers

### Base:
### Balance 12 base (BA) layer
![Base layer](https://i.imgur.com/I0TkIHT.png)

.--------.-------.-------.-------.--------. .-------.-------.-------.-------.------.
| 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
![Numeric/Punctuation layer](https://i.imgur.com/GgZ0PCq.png)

### P1: Punctuation (1)
### Function/Cursor (FC) layer
![Function/Cursor layer](https://i.imgur.com/zcVID2d.png)

.--------.-------.-------.-------.-------. .------.-------.-------.-------.------.
| 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
![Plover layer](https://i.imgur.com/RikOGXe.png)
Loading

0 comments on commit 54f104e

Please sign in to comment.