summaryrefslogtreecommitdiffstats
path: root/keyboards/contra/keymaps/erovia/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2018-09-13 18:07:21 +0200
committerDrashna Jaelre <drashna@live.com>2018-09-13 18:07:21 +0200
commitf1612b7fa19995064ad107f447932a416dbfe09b (patch)
treef565e9be511a4128f1489dba34d4acebb771d346 /keyboards/contra/keymaps/erovia/readme.md
parent5dd4b2af5381ee2d95fbcf45c4b3ad11285c3dec (diff)
downloadqmk_firmware-f1612b7fa19995064ad107f447932a416dbfe09b.tar.gz
qmk_firmware-f1612b7fa19995064ad107f447932a416dbfe09b.tar.xz
Keymap: Add Contra keymap with QWERTY and COLEMAK Mod-DH (#3883)
* Add own personal Contra layout * Enable auto-shifting * Enable tap dancing and implement Space Cadet-like shift with LSHIFT and ENTER * Implement Colemak Mod-DH layout, clean up Adjust layer * Implement keyboard and keymap refactor More info: https://github.com/qmk/qmk_firmware/pull/3191 * Update the readme.md and keymap.c files for Colemak * Add include guard, make layout description cleaner
Diffstat (limited to 'keyboards/contra/keymaps/erovia/readme.md')
-rw-r--r--keyboards/contra/keymaps/erovia/readme.md76
1 files changed, 76 insertions, 0 deletions
diff --git a/keyboards/contra/keymaps/erovia/readme.md b/keyboards/contra/keymaps/erovia/readme.md
new file mode 100644
index 000000000..34cbdf0a1
--- /dev/null
+++ b/keyboards/contra/keymaps/erovia/readme.md
@@ -0,0 +1,76 @@
+# Erovia's Contra Keymap
+
+My personal Contra keymap based on the *basic* keymap.
+
+**Features**
+
+* Qwerty and Colemak Mod-DH support
+* autoshifting
+* double tap LSHIFT and ENTER for quick access to ( and )
+
+## QWERTY (Normal) Layer
+```
+,-----------------------------------------------------------------------------------.
+| ` | Q | W | E | R | T | Y | U | I | O | P | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Esc | A | S | D | F | G | H | J | K | L | ; | ' |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Ctrl | GUI | Alt | GUI |Lower | Tab |Space |Raise | Left | Down | Up |Right |
+`-----------------------------------------------------------------------------------'
+```
+
+## Colemak Layer
+Switch from `Adjust` layer.
+```
+,-----------------------------------------------------------------------------------.
+| ` | Q | W | F | P | B | J | L | U | Y | ; | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Ctrl | A | R | S | T | G | M | N | E | I | O | ' |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift| Z | X | C | D | V | K | H | , | . | / |Enter |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Ctrl | GUI | Alt | GUI |Lower | Tab |Space |Raise | Left | Down | Up |Right |
+`-----------------------------------------------------------------------------------'
+```
+
+## Lower
+```
+,-----------------------------------------------------------------------------------.
+| ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | Next | Vol- | Vol+ | Play |
+`-----------------------------------------------------------------------------------'
+```
+
+## Raise
+```
+,-----------------------------------------------------------------------------------.
+| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | Prev | Vol- | Mute | Stop |
+`-----------------------------------------------------------------------------------'
+```
+
+## Adjust
+`AuSh` toggles autoshifting.
+```
+,-----------------------------------------------------------------------------------.
+| | | | | | | | | | | | |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| | | | | | | |Qwerty|Colemk| | | |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| | | | | | | | | | | | |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | AuSh |
+`-----------------------------------------------------------------------------------'
+```