summaryrefslogtreecommitdiff
path: root/keyboards/ergodone/keymaps/erovia/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2018-09-30 20:14:06 +0200
committerDrashna Jaelre <drashna@live.com>2018-09-30 11:14:06 -0700
commita7d46f1b0f4d18699a38898ff68114204d4c087d (patch)
treee1c1e03f0c652a88587499576de76b69bf8821c9 /keyboards/ergodone/keymaps/erovia/readme.md
parent66ef1e3d6770e388d631d25e4cd1c6b1640cea24 (diff)
Keymap: Add ErgoDone keymap with QWERTY and COLEMAK Mod-DH (#3884)
* Custom keymap for the ErgoDone The keymap supports QWERTY and COLEMAK MOD-DH with LED indication. * Enable Space Cadet Shift * Fix after-boot layer indicator LED * Implement keyboard suspend, move layer LED handling to function, unify identation * Add readme.md with layout * Optimize LED handling, add include guard Read the default layer via the proper EEPROM function, so the calling of bootmagic() is no longer necessary. Fix bug when the CapsLock LED wasn't working anymore after a layer switch.
Diffstat (limited to 'keyboards/ergodone/keymaps/erovia/readme.md')
-rw-r--r--keyboards/ergodone/keymaps/erovia/readme.md76
1 files changed, 76 insertions, 0 deletions
diff --git a/keyboards/ergodone/keymaps/erovia/readme.md b/keyboards/ergodone/keymaps/erovia/readme.md
new file mode 100644
index 0000000000..160c875983
--- /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 | | | |
+|---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+| | | | | | | | | | | | | | | |
+`---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ | | | | | | | | | | | |
+ `-----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ | | | | | |
+ ,------|------|------| |------+------+------.
+ | | | | | | | |
+ | | |------| |------| | |
+ | | | | | | | |
+ `--------------------' `--------------------'
+```