]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/niu_mini/keymaps/yttyx/README.md
Update KBD67 readme so that it mentions the KBD65 PCB (#5143)
[qmk_firmware.git] / keyboards / niu_mini / keymaps / yttyx / README.md
1 # Overview
2
3 This layout is based on Balance Twelve (mirror variant) by Sasha Viminitz. Please see [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/) 
4 for more information. It's designed for left-handers who use their right hand for the mouse.
5
6 ## To build
7
8 ```
9 make niu_mini:yttyx
10 ```
11
12 ## To flash (example)
13
14 ```
15 sudo dfu-programmer atmega32u4 erase
16 sudo dfu-programmer atmega32u4 flash niu_mini_yttyx.hex --debug 6
17 sudo dfu-programmer atmega32u4 launch
18 ```
19
20 ## Layers
21
22 ### Base:
23
24     .--------.-------.-------.-------.--------.                           .-------.-------.-------.-------.------.
25     | P      | L     | C     | D     | W      |                           | U     | O     | Y     | K     | Q    |
26     |--------+-------+-------+-------+--------|                           |-------+-------+-------+-------+------|
27     | N      | R     | S     | T     | M      |                           | A     | E     | I     | H     | V    |
28     |--------+-------+-------+-------+--------|                           |-------+-------+-------+-------+------|
29     | Z Sft  | J Ctl | F Alt | G     | B      |                           | ,     | . Alt | ; Ctl | X Sft | Sup  |
30     '--------'-------'-------+-------+--------+-----.               .-----+-------+-------+-------'-------'------'
31                              | BS P1 | Spc P2 | P3  |               |     | Sft   |       |
32                              '-------'--------'-----'               '-----'-------'-------'
33
34 ### P1: Punctuation (1)
35
36     .--------.-------.-------.-------.-------.                              .------.-------.-------.-------.------.
37     | Esc    |       |       |       |       |                              | |    | /     | ^     | £     |  ~   |
38     |--------+-------+-------+-------+-------|                              |------+-------+-------+-------+------|
39     | Tab    |       |       |       |       |                              | &    | \     | `     | $     | Ent  |
40     |--------+-------+-------+-------+-------|                              |------+-------+-------+-------+------|
41     | Sft    | Ctl   | Alt   | Del   |       |                              | %    | Alt   | Ctl   | Sft   | Sup  |
42     '--------'-------'-------+-------+-------+-----.                  .-----+------+-------+-------'-------'------'
43                              | P1    |       |     |                  |     | Sft  |       |
44                              '-------'-------'-----'                  '-----'------'-------'
45
46 ### P2: Punctuation (2)
47
48     .-------.-------.-------.-------.-------.                               .-------.-------.-------.-------.------.
49     | Esc   |       | NC    | FV    |       |                               | (     | )     | "     | ?     |      |
50     |-------+-------+-------+-------+-------|                               |-------+-------+-------+-------+------|
51     | Tab   | Ctl-X | Ctl-C | Ctl-V | Ctl-Z |                               | {     | }     | '     | !     | Ent  |
52     |-------+-------+-------+-------+-------|                               |-------+-------+-------+-------+------|
53     | Sft   | Ctl   | Alt   | Del   | Ent   |                               | #     | Alt   | Ctl   | Sft   | Sup  |
54     '-------'-------'-------+-------+-------+-----.                   .-----+-------+-------+-------'-------'------'
55                             | BS    | P2    |     |                   |     | Sft   |       |
56                             '-------'-------'-----'                   '-----'-------'-------'
57
58 ### P3: Punctuation (3)
59
60     .-------.-------.-------.-------.-------.                             .------.-------.-------.-------.------.
61     | Esc   |       | Break | Pscr  | ScLk  |                             | <    | >     | +     | _     | =    |
62     |-------+-------+-------+-------+-------|                             |------+-------+-------+-------+------|
63     | Tab   |       |       | Caps  |       |                             | [    | ]     | *     | -     | Ent  |
64     |-------+-------+-------+-------+-------|                             |------+-------+-------+-------+------|
65     | Sft   | Ctl   | Alt   | Del   |       |                             | @    | Alt   | Ctl   | Sft   | Sup  |
66     '-------'-------'-------+-------+-------+-----.                 .-----+------+-------+-------'-------'------'
67                             | BS    |       | P3  |                 |     | Sft  |       |
68                             '-------'-------'-----'                 '-----'------'-------'
69
70 ### Numerals / Cursor control
71
72     .-------.-------.-------.------.-------.                              .------.-------.-------.------.------.
73     | 1     | 2     | 3     | 4    | 5     |                              | Home | Up    | End   | PgUp |      |
74     |-------+-------+-------+------+-------|                              |------+-------+-------+------+------|
75     | 6     | 7     | 8     | 9    | 0     |                              | Left | Down  | Right | PgDn |      |
76     |-------+-------+-------+------+-------|                              |------+-------+-------+------+------|
77     | Sft   | Ctl   | Alt   | Del  | .     |                              | Ins  | Alt   | Ctl   | Sft  | Sup  |
78     '-------'-------'-------+------+-------+-----.                  .-----+------+-------+-------'------'------'
79                             | BS   | BA    |     |                  |     | Sft  |       |
80                             '------'-------'-----'                  '-----'------'-------'
81
82 ### FV: Function keys / Cursor control (Vim)
83
84     .-------.------.-------.-----.-------.                                .------.-------.-----.-------.------.
85     | F1    | F2   | F3    | F4  | F5    |                                | 0    | K     | $   | Ctl-B |      |
86     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
87     | F6    | F7   | F8    | F9  | F10   |                                | H    | J     | L   | Ctl-F |      |
88     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
89     | Sft   | Ctl  | Alt   | F11 | F12   |                                |      | Alt   | Ctl | Sft   | Sup  |
90     '-------'------'-------+-----+-------+-----.                    .-----+------+-------+-----'-------'------'
91                            | BS  | BA    |     |                    |     | Sft  |       |
92                            '-----'-------'-----'                    '-----'------'-------'