Keymap: Add ErgoDone keymap with QWERTY and COLEMAK Mod-DH (#3884)

[qmk_firmware.git] / keyboards / ergodone / keymaps / erovia / readme.md

diff --git a/keyboards/ergodone/keymaps/erovia/readme.md b/keyboards/ergodone/keymaps/erovia/readme.md
new file mode 100644 (file)
index 0000000..160c875
--- /dev/null
+++ b/keyboards/ergodone/keymaps/erovia/readme.md
@@ -0,0 +1,76 @@
+# Erovia's ErdoDone Keymap
+
+My personal ErgoDone keymap based on the *default* keymap.  
+
+**Features**
+
+* Qwerty and Colemak Mod-DH support
+* Space Cadet Shift
+* LED indicator for: active layout, CapsLock, Function layer
+
+## QWERTY (Normal) Layer
+```
+,--------------------------------------------------.           ,--------------------------------------------------.
+|   `    |   1  |   2  |   3  |   4  |   5  | Copy |           | Paste|   6  |   7  |   8  |   9  |   0  | Sleep  |
+|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+|  Tab   |   Q  |   W  |   E  |   R  |   T  | Mute |           |  {   |   Y  |   U  |   I  |   O  |   P  |   \    |
+|--------+------+------+------+------+------|      |           |  [   |------+------+------+------+------+--------|
+|  Esc   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
+|--------+------+------+------+------+------| Fn1  |           |  }   |------+------+------+------+------+--------|
+| LShift |   Z  |   X  |   C  |   V  |   B  |      |           |  ]   |   N  |   M  |   ,  |   .  |   /  | RShift |
+`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+  |LCtrl | LGui | LAlt | Left | Right|                                       | Down |  Up  |   -  |   =  | RCtrl |
+  `----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       | Caps | LGui |       | Ins  |  Del |
+                                ,------|------|------|       |------+--------+------.
+                                |      |      | Home |       | PgUp |        |      |
+                                | Space|Backsp|------|       |------|  Tab   |Enter |
+                                |      |ace   | End  |       | PgDn |        |      |
+                                `--------------------'       `----------------------'
+```
+
+## Colemak Layer
+Switch from `Fn1` layer.
+```
+,--------------------------------------------------.           ,--------------------------------------------------.
+|   `    |   1  |   2  |   3  |   4  |   5  | Copy |           | Paste|   6  |   7  |   8  |   9  |   0  | Sleep  |
+|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+|  Tab   |   Q  |   W  |   F  |   P  |   B  | Mute |           |  {   |   J  |   L  |   U  |   Y  |   ;  |   \    |
+|--------+------+------+------+------+------|      |           |  [   |------+------+------+------+------+--------|
+|  Esc   |   A  |   R  |   S  |   T  |   G  |------|           |------|   M  |   N  |   E  |   I  |   O  |   '    |
+|--------+------+------+------+------+------| Fn1  |           |  }   |------+------+------+------+------+--------|
+| LShift |   Z  |   X  |   C  |   D  |   V  |      |           |  ]   |   K  |   H  |   ,  |   .  |   /  | RShift |
+`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+  |LCtrl | LGui | LAlt | Left | Right|                                       | Down |  Up  |   -  |   =  | RCtrl |
+  `----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       | Caps | LGui |       | Ins  |  Del |
+                                ,------|------|------|       |------+--------+------.
+                                |      |      | Home |       | PgUp |        |      |
+                                | Space|Backsp|------|       |------|  Tab   |Enter |
+                                |      |ace   | End  |       | PgDn |        |      |
+                                `--------------------'       `----------------------'
+```
+
+## Function Layer
+```
+,---------------------------------------------------.           ,--------------------------------------------------.
+|Version  |  F1  |  F2  |  F3  |  F4  |  F5  | F11  |           |  F12 |  F6  |  F7  |  F8  |  F9  |  F10 |        |
+|---------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
+|         |      |      | Prev | Play | Next |      |           |      |      |      |      |      |      |        |
+|---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|         |      |      |      |VolDn | VolUp|------|           |------|      |QWRTY | CLMK |     |      |        |
+|---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|         |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
+`---------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+  |       |      |      |      |      |                                       |      |      |      |      |      |
+  `-----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       |      |      |       |      |      |
+                                ,------|------|------|       |------+------+------.
+                                |      |      |      |       |      |      |      |
+                                |      |      |------|       |------|      |      |
+                                |      |      |      |       |      |      |      |
+                                `--------------------'       `--------------------'
+```