]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/atreus/keymaps/yttyx/README.md
Update KBD67 readme so that it mentions the KBD65 PCB (#5143)
[qmk_firmware.git] / keyboards / atreus / 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 sudo make atreus:yttyx
10 ```
11
12 ## To flash (example)
13
14 ```
15 sudo avrdude -p atmega32u4 -c avr109 -U flash:w:atreus_yttyx.hex -P /dev/ttyACM0
16 ```
17
18 ## Layers
19
20 ### Base:
21
22     .--------.-------.-------.-------.--------.                           .-------.-------.-------.-------.------.
23     | P      | L     | C     | D     | W      |                           | U     | O     | Y     | K     | Q    |
24     |--------+-------+-------+-------+--------|                           |-------+-------+-------+-------+------|
25     | N      | R     | S     | T     | M      |                           | A     | E     | I     | H     | V    |
26     |--------+-------+-------+-------+--------|                           |-------+-------+-------+-------+------|
27     | Z Sft  | J Ctl | F Alt | G     | B      |                           | ,     | . Alt | ; Ctl | X Sft | Sup  |
28     '--------'-------'-------+-------+--------+-----.               .-----+-------+-------+-------'-------'------'
29                              | BS P1 | Spc P2 | P3  |               |     | Sft   |       |
30                              '-------'--------'-----'               '-----'-------'-------'
31
32 ### P1: Punctuation (1)
33
34
35     .--------.-------.-------.-------.-------.                              .------.-------.-------.-------.------.
36     | Esc    |       |       |       | RS    |                              | |    | /     | ^     | £     |  ~   |
37     |--------+-------+-------+-------+-------|                              |------+-------+-------+-------+------|
38     | Tab    |       |       |       |       |                              | &    | \     | `     | $     | Ent  |
39     |--------+-------+-------+-------+-------|                              |------+-------+-------+-------+------|
40     | Sft    | Ctl   | Alt   | Del   |       |                              | %    | Alt   | Ctl   | Sft   | Sup  |
41     '--------'-------'-------+-------+-------+-----.                  .-----+------+-------+-------'-------'------'
42                              | P1    |       |     |                  |     | Sft  |       |
43                              '-------'-------'-----'                  '-----'------'-------'
44
45 ### P2: Punctuation (2)
46
47     .-------.-------.-------.-------.-------.                               .-------.-------.-------.-------.------.
48     | Esc   |       | NC    | FV    |       |                               | (     | )     | "     | ?     |      |
49     |-------+-------+-------+-------+-------|                               |-------+-------+-------+-------+------|
50     | Tab   | Ctl-X | Ctl-C | Ctl-V | Ctl-Z |                               | {     | }     | '     | !     | Ent  |
51     |-------+-------+-------+-------+-------|                               |-------+-------+-------+-------+------|
52     | Sft   | Ctl   | Alt   | Del   | Ent   |                               | #     | Alt   | Ctl   | Sft   | Sup  |
53     '-------'-------'-------+-------+-------+-----.                   .-----+-------+-------+-------'-------'------'
54                             | BS    | P2    |     |                   |     | Sft   |       |
55                             '-------'-------'-----'                   '-----'-------'-------'
56
57 ### P3: Punctuation (3)
58
59     .-------.-------.-------.-------.-------.                             .------.-------.-------.-------.------.
60     | Esc   |       | Break | Pscr  | ScLk  |                             | <    | >     | +     | _     | =    |
61     |-------+-------+-------+-------+-------|                             |------+-------+-------+-------+------|
62     | Tab   |       |       | Caps  |       |                             | [    | ]     | *     | -     | Ent  |
63     |-------+-------+-------+-------+-------|                             |------+-------+-------+-------+------|
64     | Sft   | Ctl   | Alt   | Del   |       |                             | @    | Alt   | Ctl   | Sft   | Sup  |
65     '-------'-------'-------+-------+-------+-----.                 .-----+------+-------+-------'-------'------'
66                             | BS    |       | P3  |                 |     | Sft  |       |
67                             '-------'-------'-----'                 '-----'------'-------'
68
69 ### Numerals / Cursor control
70
71     .-------.-------.-------.------.-------.                              .------.-------.-------.------.------.
72     | 1     | 2     | 3     | 4    | 5     |                              | Home | Up    | End   | PgUp |      |
73     |-------+-------+-------+------+-------|                              |------+-------+-------+------+------|
74     | 6     | 7     | 8     | 9    | 0     |                              | Left | Down  | Right | PgDn |      |
75     |-------+-------+-------+------+-------|                              |------+-------+-------+------+------|
76     | Sft   | Ctl   | Alt   | Del  | .     |                              | Ins  | Alt   | Ctl   | Sft  | Sup  |
77     '-------'-------'-------+------+-------+-----.                  .-----+------+-------+-------'------'------'
78                             | BS   | BA    |     |                  |     | Sft  |       |
79                             '------'-------'-----'                  '-----'------'-------'
80
81 ### FV: Function keys / Cursor control (Vim)
82
83     .-------.------.-------.-----.-------.                                .------.-------.-----.-------.------.
84     | F1    | F2   | F3    | F4  | F5    |                                | 0    | K     | $   | Ctl-B |      |
85     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
86     | F6    | F7   | F8    | F9  | F10   |                                | H    | J     | L   | Ctl-F |      |
87     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
88     | Sft   | Ctl  | Alt   | F11 | F12   |                                |      | Alt   | Ctl | Sft   | Sup  |
89     '-------'------'-------+-----+-------+-----.                    .-----+------+-------+-----'-------'------'
90                            | BS  | BA    |     |                    |     | Sft  |       |
91                            '-----'-------'-----'                    '-----'------'-------'
92
93 ### RS: Reset
94
95     .-------.------.-------.-----.-------.                                .------.-------.-----.-------.------.
96     | RESET |      |       |     |       |                                |      |       |     |       |      |
97     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
98     |       |      |       |     |       |                                |      |       |     |       |      |
99     |-------+------+-------+-----+-------|                                |------+-------+-----+-------+------|
100     |       |      |       |     |       |                                |      |       |     |       |      |
101     '-------'------'-------+-----+-------+-----.                    .-----+------+-------+-----'-------'------'
102                            |     | BA    |     |                    |     |      |       |
103                            '-----'-------'-----'                    '-----'------'-------'