Merge pull request #1197 from Xyverz/master

[qmk_firmware.git] / keyboards / ergodox / keymaps / xyverz / readme.md

diff --git a/keyboards/ergodox/keymaps/xyverz/readme.md b/keyboards/ergodox/keymaps/xyverz/readme.md
index 8f6dba45e9a67d28de86d871996b180384b66f2e..134fb50afdbbf35e599351ec3ab63afee770472f 100644 (file)
--- a/keyboards/ergodox/keymaps/xyverz/readme.md
+++ b/keyboards/ergodox/keymaps/xyverz/readme.md
@@ -1,10 +1,122 @@
-# ErgoDox EZ Default Configuration
+# Xyverz's ErgoDox EZ Keymap
 
-## Changelog
+## About this keymap:
 
-* Feb 2, 2016 (V1.1): 
-  * Made the right-hand quote key double as Cmd/Win on hold. So you get ' when you tap it, " when you tap it with Shift, and Cmd or Win when you hold it. You can then use it as a modifier, or just press and hold it for a moment (and then let go) to send a single Cmd or Win keystroke (handy for opening the Start menu on Windows).
+The Dvorak layout shown here stems 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.~~ I've decided do give the normal placing of the SLSH, EQL, and xBRC keys a try, after using a different keyboard for a while...
 
-This is what we ship with out of the factory. :) The image says it all:
+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.
 
-![Default](default_highres.png)
+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    |   '  |   ,  |   .  |   P  |   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|      |
+         `----------------------------------'                            `----------------------------------'
+                                            ,-------------.,-------------.
+                                            |      |      ||      |      |
+                                     ,------|------|------||------+------+------.
+                                     |      |      |      ||      |      |      |
+                                     |      |      |------||------|      |      |
+                                     |      |      |      ||      |      |      |
+                                     `--------------------'`--------------------'