Added a readme, tidied up comments in the keymap.

2 files changed, 147 insertions, 29 deletions

diff --git a/keyboards/ergodox/keymaps/xyverz/keymap.c b/keyboards/ergodox/keymaps/xyverz/keymap.c
index c5ce99dd22..7a16367bfa 100644
--- a/keyboards/ergodox/keymaps/xyverz/keymap.c
+++ b/keyboards/ergodox/keymaps/xyverz/keymap.c
@@ -1,4 +1,10 @@
 /*
+ * PLEASE NOTE: This keymap will NOT work with the Infinity ErgoDox due to the fact that the mappings are
+ * based on the Matrix Layout in the ez.h file. If you want to use this for the infinity, you'll need to 
+ * figure out where the keys are in the matrix and redo the layout arrays below.
+ * 
+ * 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.
@@ -33,8 +39,9 @@ extern keymap_config_t keymap_config;
 #define COLEMAK M(_CM)
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-/* Keymap 0: Dvorak layer
- *
+
+[_DV] = {  // layer 0 : Dvorak
+/*  
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * |   ]    |   1  |   2  |   3  |   4  |   5  | ESC  |           | ESC  |   6  |   7  |   8  |   9  |   0  |   [    |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
@@ -55,9 +62,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 `--------------------'       `--------------------'
  *
  */
-// If it accepts an argument (i.e, is a function), it doesn't need KC_.
-// Otherwise, it needs KC_*
-[_DV] = {  // layer 0 : Dvorak
         // left hand
 	{KC_RBRC, KC_TAB,  KC_CAPS, KC_LSFT, KC_LGUI, KC_NO  },
 	{KC_1,    KC_QUOT, KC_A,    KC_SCLN, KC_GRV,  KC_END },
@@ -77,8 +81,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	{KC_LBRC, KC_BSLS, KC_MINS, KC_RSFT, KC_RGUI, KC_NO  }
 },
 
-/* Keymap 1: QWERTY layer
- *
+
+[_QW] = {  // layer 1 : QWERTY
+/* 
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * |   =    |   1  |   2  |   3  |   4  |   5  | ESC  |           | ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
@@ -98,9 +103,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      | End  |       | PgDn |      |      |
  *                                 `--------------------'       `--------------------'
  */
-// If it accepts an argument (i.e, is a function), it doesn't need KC_.
-// Otherwise, it needs KC_*
-[_QW] = {  // layer 1 : QWERTY
         // left hand
 	{KC_EQL,  KC_TAB,  KC_CAPS, KC_LSFT, KC_LGUI, KC_NO  },
 	{KC_1,    KC_Q,    KC_A,    KC_Z,    KC_GRV,  KC_END },
@@ -120,8 +122,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	{KC_MINS, KC_BSLS, KC_QUOT, KC_RSFT, KC_RGUI, KC_NO  }
   },
 
-/* Keymap 2: Colemak layer
- *
+
+[_CM] = {  // layer 2 : Colemak
+/* 
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * |   =    |   1  |   2  |   3  |   4  |   5  | ESC  |           | ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
@@ -141,9 +144,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      | End  |       | PgDn |      |      |
  *                                 `--------------------'       `--------------------'
  */
-// If it accepts an argument (i.e, is a function), it doesn't need KC_.
-// Otherwise, it needs KC_*
-[_CM] = {  // layer 2 : Colemak
         // left hand
 	{KC_EQL,  KC_TAB,  KC_BSPC, KC_LSFT, KC_LGUI, KC_NO  },
 	{KC_1,    KC_Q,    KC_A,    KC_Z,    KC_GRV,  KC_END },
@@ -163,15 +163,16 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	{KC_MINS, KC_BSLS, KC_QUOT, KC_RSFT, KC_RGUI, KC_NO  }
   },
 
-/* Keymap 3: Symbol Layer
- *
+
+[_MD] = { // layer 3 : Media layer
+/* 
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * | TEENSY |  F1  |  F2  |  F3  |  F4  |  F5  | F11  |           |  F12 |  F6  |  F7  |  F8  |  F9  |  F10 |        |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
- * |        |      | PrSc | ScLk | Paus |      | FN4  |           |  FN5 |      | Mute | Vol- | Vol+ |      |        |
+ * |        |      | PrSc | ScLk | Paus |      |      |           |      |      | Mute | Vol- | Vol+ |      |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |      |      |      |      |      |------|           |------| Stop | Prev | Play | Next | Sel  |        |
- * |--------+------+------+------+------+------| FN4  |           |  FN5 |------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |      |Dvorak|Qwerty|Colemk|      |      |           |      |      |      |      |      |      |        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  *   |      |      |      |      |      |                                       |      |      |      |      |      |
@@ -184,8 +185,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
  */
-// Media Layer
-[_MD] = { // layer 3 : Media layer
         // left hand
 	{RESET,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_NO  },
 	{KC_F1,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
@@ -205,15 +204,16 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_NO  }
   },
 
-/* Keymap 4: Keypad layer
- *
+
+[_KP] = { // layer 4 : Keypad layer
+/* 
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * | Power  |      |      |      |      |      |      |           |      |      | NmLk | KP / | KP * | KP - |        |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
- * | Sleep  |      |      |      |      |      | FN5  |           |  FN4 |      | KP 7 | KP 8 | KP 9 | KP + |        |
+ * | Sleep  |      |      |      |      |      |      |           |      |      | KP 7 | KP 8 | KP 9 | KP + |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * | Wake   |      |      |      |      |      |------|           |------|      | KP 4 | KP 5 | KP 6 | KP + |        |
- * |--------+------+------+------+------+------| FN5  |           |  FN4 |------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |      |      |      |      |      |      |           |      |      | KP 1 | KP 2 | KP 3 |KP Ent|        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  *   |      |      |      |      |      |                                       | KP 0 |      | KP . |KP Ent|      |
@@ -226,8 +226,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
  */
-// Keypad Layer
-[_KP] = { // layer 4 : Keypad layer
         // left hand
 	{KC_PWR,  KC_SLEP, KC_WAKE, KC_TRNS, KC_TRNS, KC_NO  },
 	{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS},
@@ -247,6 +245,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_NO,   KC_NO  }
   },
 
+
 };
 
 const uint16_t PROGMEM fn_actions[] = {
diff --git a/keyboards/ergodox/keymaps/xyverz/readme.md b/keyboards/ergodox/keymaps/xyverz/readme.md
index 22e771b091..42ae8fe539 100644
--- a/keyboards/ergodox/keymaps/xyverz/readme.md
+++ b/keyboards/ergodox/keymaps/xyverz/readme.md
@@ -1,5 +1,124 @@
-# PLEASE NOTE
+# Xyverz's ErgoDox EZ Keymap
 
-## This keymap is optomised for the EZ and Original ergodox. 
+## Please Note:
 
 It will need **substantial** modification in order to work on the Infinity.
+
+PLEASE NOTE: This keymap will NOT work with the Infinity ErgoDox due to the fact that the mappings are based on the Matrix Layout in the ez.h file. If you want to use this for the infinity, you'll need to figure out where the keys are in the matrix and redo the layout arrays below.
+
+## 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.
+
+For a better explanation of the layout matrices shown below, take a look at ../../ez/ez.h where the keymap is defined, beginning on line 81.
+
+### 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|      |
+  `----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       |      |      |       |      |      |
+                                ,------|------|------|       |------+------+------.
+                                |      |      |      |       |      |      |      |
+                                |      |      |------|       |------|      |      |
+                                |      |      |      |       |      |      |      |
+                                `--------------------'       `--------------------'