summaryrefslogtreecommitdiff
path: root/keyboards/atreus/keymaps/yttyx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/atreus/keymaps/yttyx/README.md')
-rw-r--r--keyboards/atreus/keymaps/yttyx/README.md158
1 files changed, 92 insertions, 66 deletions
diff --git a/keyboards/atreus/keymaps/yttyx/README.md b/keyboards/atreus/keymaps/yttyx/README.md
index 9ed9d6239b..aac02c6c11 100644
--- a/keyboards/atreus/keymaps/yttyx/README.md
+++ b/keyboards/atreus/keymaps/yttyx/README.md
@@ -1,77 +1,103 @@
# Overview
-A Balance 12 layout for the Atreus keyboard.
+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.
-Balance 12 was created by Sasha Viminitz. Please see [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/)
-for some background on the design of the layout.
+## To build
-* The variant used here is a mirror of the original for left-handers
-* The central column of punctuation keys has been moved elsewhere
-* Home positions for the left and right forefingers are *T* and *A* respectively
+```
+sudo make atreus:yttyx
+```
-## To build/flash
+## To flash (example)
-> make atreus:yttyx:avrdude
+```
+sudo avrdude -p atmega32u4 -c avr109 -U flash:w:atreus_yttyx.hex -P /dev/ttyACM0
+```
## Layers
### Base:
- .----------------------------------. .------------------------------.
- | P | L | C | D | W | | U | O | Y | K | Q |
- +------+------+------+-----+-------| |------+-----+-----+-----+-----|
- | N | R | S | T | M | | A | E | I | H | V |
- +------+------+------+-----+-------| |------+-----+-----+-----+-----|
- | Z | J | F | G | B | | , | . | ; | X | - |
- +------+------+------+-----+-------+---------+------+-----+-----+-----+-----|
- | Shft | Ctl | Alt | BS | Space | L1 | R1 | Shft | R2 | Win | Ctl | Alt |
- '---------------------------------------------------------------------------'
-
-### L1:
-
- .---------------------------------. .--------------------------------.
- | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 |
- |------+------+------+----+-------| |------+----+-----+------+-------|
- | Tab | ? | = | - | _ | | ' | " | + | * | Enter |
- |------+------+------+----+-------| |------+----+-----+------+-------|
- | Esc | ! | & | | | | , | . | ; | | - |
- |------+------+------+----+-------+---------+------+----+-----+------+-------|
- | Shft | Ctrl | Alt | Bk | Space | L1 | R1 | Shft | R2 | Sup | Ctrl | Alt |
- '----------------------------------------------------------------------------'
-
-### R1:
-
- .---------------------------------. .-------------------------------.
- | < | > | { | } | @ | | $ | £ | | | R3 |
- +------+------+-----+-----|-------| |------+----+-----+------+------|
- | [ | ] | ( | ) | # | | ' | " | ~ | ` | Caps |
- |------+------+-----+-----+-------| |------+----+-----+------+------|
- | / | \ | ^ | | | % | | , | . | ; | | PScn |
- |------+------+-----+-----+-------+---------+------+----+-----+------+------|
- | Shft | Ctrl | Alt | Del | Space | L1 | R1 | Shft | R2 | Sup | Ctrl | Alt |
- '---------------------------------------------------------------------------'
-
-### R2:
-
- .-----------------------------------. .--------------------.-----------------.
- | F12 | F11 | F10 | F9 | Copy | | Home | Up | End | PgUp | Insert |
- |------+------+------+------+-------| |------+------+------+------+----------|
- | F8 | F7 | F6 | F5 | Paste | | Left | Down | Right| PgDn | Enter |
- |------+------+------+------+-------| |------+------+------+------+----------|
- | F4 | F3 | F2 | F1 | Cut | | ^Tab | | Tab | | |
- |------+------+------+------+-------+---------+------+------+------+------+----------|
- | Shft | Ctrl | Alt | Del | Undo | L1 | R1 | Shft | R2 | Sup | Ctrl | WinRight |
- '------------------------------------------------------------------------------------'
-
-### R3:
-
- .----------------------------. .------------------------.
- | RESET | | | | | | | | | | R3 |
- |-------+----+-----+----+----| |----+----+----+----+----|
- | | | | | | | | | | | |
- |-------+----+-----+----+----| |----+----+----+----+----|
- | | | | | | | | | | | |
- |-------+----+-----+----+----+---------+----+----+----+----+----|
- | | | | | | | | | | | | |
- '---------------------------------------------------------------'
-
+ .--------.-------.-------.-------.--------. .-------.-------.-------.-------.------.
+ | 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 | |
+ '-------'--------'-----' '-----'-------'-------'
+
+### P1: Punctuation (1)
+
+
+ .--------.-------.-------.-------.-------. .------.-------.-------.-------.------.
+ | Esc | | | | RS | | | | / | ^ | £ | ~ |
+ |--------+-------+-------+-------+-------| |------+-------+-------+-------+------|
+ | 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 | |
+ '-----'-------'-----' '-----'------'-------'
+
+### RS: Reset
+
+ .-------.------.-------.-----.-------. .------.-------.-----.-------.------.
+ | RESET | | | | | | | | | | |
+ |-------+------+-------+-----+-------| |------+-------+-----+-------+------|
+ | | | | | | | | | | | |
+ |-------+------+-------+-----+-------| |------+-------+-----+-------+------|
+ | | | | | | | | | | | |
+ '-------'------'-------+-----+-------+-----. .-----+------+-------+-----'-------'------'
+ | | BA | | | | | |
+ '-----'-------'-----' '-----'------'-------'