summaryrefslogtreecommitdiff
path: root/keyboards
diff options
context:
space:
mode:
authorXyverz <xyverz@gmail.com>2017-04-06 22:03:17 -0700
committerXyverz <xyverz@gmail.com>2017-04-06 22:03:17 -0700
commit8813365ec5c091c0185563943bbf73ec53d846e0 (patch)
treea62fd610b8f4de98c46d9d5636a2dd4d59a69e48 /keyboards
parent3a5f9faca969487bbf7eeaf0ba921dc0d9bef6d2 (diff)
Added readme
Diffstat (limited to 'keyboards')
-rw-r--r--keyboards/atreus/keymaps/xyverz/readme.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/keyboards/atreus/keymaps/xyverz/readme.md b/keyboards/atreus/keymaps/xyverz/readme.md
new file mode 100644
index 0000000000..29c0422bbb
--- /dev/null
+++ b/keyboards/atreus/keymaps/xyverz/readme.md
@@ -0,0 +1,89 @@
+# Xyverz's Atreus Keymap
+
+## About this keymap:
+
+This is the second iteration of my Atreus keymap. The first one was as close to the planck as I could get at the
+time, but still very much like the original Atreus keymap. I've managed to get things working better now and have
+implemented (more like copied) the RAISE/LOWER/ADJUST layers. This is a work in progress, but I think I'm closer
+to a final go with this.
+
+I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
+
+## Still to do:
+
+ * Tidy the keymap up so that it's readable.
+ * Learn how to make alias macros for mod_tap keys.
+
+### Layer 0: Dvorak layer
+
+ ,----------------------------------. ,----------------------------------.
+ | ' | , | . | P | Y | | F | G | C | R | L |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | A | O | E | U | I | | D | H | T | N | S |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ |Shft ;| Q | J | K | X | CTRL ||Alt / | B | M | W | V |Shft Z|
+ |------+------+------+------+------| ||Enter |------+------+------+------+------|
+ | Esc | Tab | GUI | LOWER| BkSp |------'`------| Spc | RAISE| - | / | \ |
+ `----------------------------------' `----------------------------------'
+
+### Layer 1: QWERTY layer
+
+ ,----------------------------------. ,----------------------------------.
+ | Q | W | E | R | T | | Y | U | I | O | P |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | A | S | D | F | G | | H | J | K | L | ; |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ |Shft Z| X | C | V | B | CTRL ||Alt / | N | M | , | . |Shft /|
+ |------+------+------+------+------| ||Enter |------+------+------+------+------|
+ | Esc | Tab | GUI | LOWER| BkSp |------'`------| Spc | RAISE| - | ' | \ |
+ `----------------------------------' `----------------------------------'
+
+### Keymap 2: Colemak layer
+
+ ,----------------------------------. ,----------------------------------.
+ | Q | W | F | P | G | | J | L | U | Y | L |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | A | R | S | T | D | | H | N | E | I | S |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ |Shft Z| X | C | V | B | CTRL ||Alt / | K | M | , | . |Shft /|
+ |------+------+------+------+------| ||Enter |------+------+------+------+------|
+ | Esc | Tab | GUI | LOWER| BkSp |------'`------| Spc | RAISE| - | ' | RGUI |
+ `----------------------------------' `----------------------------------'
+
+### layer 3 : LOWER layer
+
+ ,----------------------------------. ,----------------------------------.
+ | ! | @ | # | $ | % | | ^ | & | * | ( | ) |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | CAPS | | UP | | Home | | PgDn | | + | { | } |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ | | Left | Down | Right| End | || | PgUp | Mute | Vol- | Vol+ | |
+ |------+------+------+------+------| || |------+------+------+------+------|
+ | ~ | | | | Del |------'`------| Ins | | | | |
+ `----------------------------------' `----------------------------------'
+
+
+### Keymap 4: RAISE layer
+
+ ,----------------------------------. ,----------------------------------.
+ | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | CAPS | | UP | | Home | | PgDn | | = | [ | ] |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ | | Left | Down | Right| End | || | PgUp | Prev | Play | Next | |
+ |------+------+------+------+------| || |------+------+------+------+------|
+ | ` | | | | Del |------'`------| Ins | | | | |
+ `----------------------------------' `----------------------------------'
+
+### Keymap 5: ADJUST layer
+
+ ,----------------------------------. ,----------------------------------.
+ | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 |
+ |------+------+------+------+------| |------+------+------+------+------|
+ | F11 | | | | | | | | | | F12 |
+ |------+------+------+------+------|------.,------|------+------+------+------+------|
+ | |QWERTY|COLEMK|DVORAK| | || | | | | | |
+ |------+------+------+------+------| || |------+------+------+------+------|
+ | | | | | |------'`------| | | | | RESET|
+ `----------------------------------' `----------------------------------'
+