summaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/xyverz/readme.md
diff options
context:
space:
mode:
authorRyan Ascheman <rascheman@groupon.com>2016-10-18 12:42:02 -0700
committerRyan Ascheman <rascheman@groupon.com>2016-10-18 12:42:02 -0700
commit55b8b8477cc6aee82dfe6792eea4e589cac433d5 (patch)
treece5bfbd1b0ee59dbffdc2044bcf90c89614392ed /keyboards/ergodox/keymaps/xyverz/readme.md
parentd1c70328f8d8ded6ce1e5422b468fc41ef315e7d (diff)
parent04df74f6360464661bcc1e6794e9fd3549084390 (diff)
Merge remote-tracking branch 'upstream/master'
* upstream/master: (1239 commits) Update ez.c removes planck/rev3 temporarily Move hand_swap_config to ez.c, removes error for infinity Update Makefile ergodox: Update algernon's keymap to v1.9 Added VS Code dir to .gitignore Support the Pegasus Hoof controller. [Jack & Erez] Simplifies and documents TO add readme use wait_ms instead of _delay_ms add messenger init keymap Add example keymap Adding whiskey_tango_foxtrot_capslock ergodox keymap Unicode map framework. Allow unicode up to 0xFFFFF using separate mapping table CIE 1931 dim curve Apply the dim curve to the RGB output Update the Cluecard readme files Tune snake and knight intervals for Cluecard Tunable RGB light intervals ...
Diffstat (limited to 'keyboards/ergodox/keymaps/xyverz/readme.md')
-rw-r--r--keyboards/ergodox/keymaps/xyverz/readme.md122
1 files changed, 122 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/xyverz/readme.md b/keyboards/ergodox/keymaps/xyverz/readme.md
new file mode 100644
index 0000000000..6ecdabc9ed
--- /dev/null
+++ b/keyboards/ergodox/keymaps/xyverz/readme.md
@@ -0,0 +1,122 @@
+# Xyverz's ErgoDox EZ Keymap
+
+## About this keymap:
+
+The Dvorak layout shown herestems from my early Kinesis years, using the Contour PS/2 with a Dvorak software layout. Because of this, the RBRC and LBRC were on opposite sides of the board in the corner keys. I've decided to continue using this layout with my ErgoDox.
+
+The QWERTY layout shown here is based entirely on the Kinesis Advantage layout, with the additional keys as shown in the diagrams. The Colemak layout is merely an adaptation of that.
+
+I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
+
+## Still to do:
+
+ * Need to figure out a better position for the ESC key.
+ * Come up with a function for the empty keys shown in the alpha layers below.
+ * Fix the CapsLock, NumLock, and ScrLck LEDs.
+
+### Layer 0: Dvorak layer
+
+ ,--------------------------------------------------.,--------------------------------------------------.
+ | ] | 1 | 2 | 3 | 4 | 5 | ESC || ESC | 6 | 7 | 8 | 9 | 0 | [ |
+ |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
+ | Tab | ' | , | . | Y | Y | || | F | G | C | R | L | \ |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | CapsLk | A | O | E | U | I |------||------| D | H | T | N | S | - |
+ |--------+------+------+------+------+------| _MD || _KP |------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | X | || | B | M | W | V | Z | RShift |
+ `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
+ | LGUI | ` | INS | Left | Rght | | Up | Dn | / | = | RGUI |
+ `----------------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | LCtr | LAlt || Ralt | RCtr |
+ ,------|------|------||------+------+------.
+ | | | Home || PgUp | | |
+ | BkSp | Del |------||------| Enter| Space|
+ | | | End || PgDn | | |
+ `--------------------'`--------------------'
+
+### Layer 1: QWERTY layer
+
+ ,--------------------------------------------------.,--------------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | ESC || ESC | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T | || | Y | U | I | O | P | \ |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | CapsLk | A | S | D | F | G |------||------| H | J | K | L | ; | ' |
+ |--------+------+------+------+------+------| _MD || _KP |------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | B | || | N | M | , | . | / | RShift |
+ `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
+ | LGUI | ` | INS | Left | Rght | | Up | Dn | [ | ] | RGUI |
+ `----------------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | LCtr | LAlt || Ralt | RCtr |
+ ,------|------|------||------+------+------.
+ | | | Home || PgUp | | |
+ | BkSp | Del |------||------| Enter| Space|
+ | | | End || PgDn | | |
+ `--------------------'`--------------------'
+
+### Keymap 2: Colemak layer
+
+ ,--------------------------------------------------.,--------------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | ESC || ESC | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
+ | Tab | Q | W | F | P | G | || | J | L | U | Y | ; | \ |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | BkSpc | A | R | S | T | D |------||------| H | N | E | I | O | ' |
+ |--------+------+------+------+------+------| _MD || _KP |------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | B | || | K | M | , | . | / | RShift |
+ `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
+ | LGUI | ` | INS | Left | Rght | | Up | Dn | [ | ] | RGUI |
+ `----------------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | LCtr | LAlt || Ralt | RCtr |
+ ,------|------|------||------+------+------.
+ | | | Home || PgUp | | |
+ | BkSp | Del |------||------| Enter| Space|
+ | | | End || PgDn | | |
+ `--------------------'`--------------------'
+
+### layer 3 : Media layer
+
+ ,--------------------------------------------------.,--------------------------------------------------.
+ | TEENSY | F1 | F2 | F3 | F4 | F5 | F11 || F12 | F6 | F7 | F8 | F9 | F10 | |
+ |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
+ | | | PrSc | ScLk | Paus | | || | | Mute | Vol- | Vol+ | | |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | | | | | | |------||------| Stop | Prev | Play | Next | Sel | |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | | |Dvorak|Qwerty|Colemk| | || | | | | | | |
+ `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
+ | | | | | | | | | | | |
+ `----------------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | | || | |
+ ,------|------|------||------+------+------.
+ | | | || | | |
+ | | |------||------| | |
+ | | | || | | |
+ `--------------------'`--------------------'
+
+
+
+### Keymap 4: Keypad layer
+
+ ,--------------------------------------------------.,--------------------------------------------------.
+ | Power | | | | | | || | | NmLk | KP = | KP / | KP * | |
+ |--------+------+------+------+------+-------------||------+------+------+------+------+------+--------|
+ | Sleep | | | | | | || | | KP 7 | KP 8 | KP 9 | KP - | |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | Wake | | | | | |------||------| | KP 4 | KP 5 | KP 6 | KP + | |
+ |--------+------+------+------+------+------| || |------+------+------+------+------+--------|
+ | | | | | | | || | | KP 1 | KP 2 | KP 3 |KP Ent| |
+ `--------+------+------+------+------+-------------'`-------------+------+------+------+------+--------'
+ | | | | | | | KP 0 | | KP . |KP Ent| |
+ `----------------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | | || | |
+ ,------|------|------||------+------+------.
+ | | | || | | |
+ | | |------||------| | |
+ | | | || | | |
+ `--------------------'`--------------------'