aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authorJosh Colbeck <skrymir@gmail.com>2017-02-21 20:31:16 -0600
committerJosh Colbeck <skrymir@gmail.com>2017-02-21 20:31:16 -0600
commite51001efcc3ff8b64f8264e8bd4c2dbea15f3364 (patch)
treebdf5a0a4b44d5e63ba1376b70d94f64c77f3c90c /keyboards/ergodox/keymaps/twey/readme.md
parentc56693f858cb3409e4a68a8e65a1370c022a51ed (diff)
parent7ff41df32c29bca4e3a6efc3047b8fa93bb99b92 (diff)
downloadfirmware-e51001efcc3ff8b64f8264e8bd4c2dbea15f3364.tar.gz
firmware-e51001efcc3ff8b64f8264e8bd4c2dbea15f3364.tar.bz2
firmware-e51001efcc3ff8b64f8264e8bd4c2dbea15f3364.zip
Merge remote-tracking branch 'qmk/master'
Diffstat (limited to 'keyboards/ergodox/keymaps/twey/readme.md')
-rw-r--r--keyboards/ergodox/keymaps/twey/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/twey/readme.md b/keyboards/ergodox/keymaps/twey/readme.md
new file mode 100644
index 000000000..979e4261e
--- /dev/null
+++ b/keyboards/ergodox/keymaps/twey/readme.md
@@ -0,0 +1,17 @@
+# Twey's Home Configuration
+## Layers
+- Layer 0: Non-ANSI Dvorak layout, with modified modifiers — all
+ modifiers on thumb keys, as well as return and space.
+- Layer 1: Default symbol layout.
+- Layer 2: Plover-oriented stenography layer.
+- Layer 3: Extended media/mouse layout.
+
+## Unusual features
+The Plover key (top right key on the left half) also sends my Plover
+‘toggle’ chord (SH-FT) when pressed, as well as toggling the steno
+layer, so you can toggle between steno and typing modes with a single
+keypress.
+
+If you want to use this feature, you'll need to add the
+`commands.json` dictionary to your Plover dictionaries, or define the
+toggle stroke (`PHROLG`) yourself.