summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authordi0ib2016-08-07 20:20:16 -1000
committerdi0ib2016-08-07 20:20:16 -1000
commita36b2a0756761513a9853af78d61e8b666b34aa7 (patch)
treea783cea131f5afe22788809a069b1a365a9c3fba /keyboards/ergodox/keymaps/twey/readme.md
parent8610481c372e9de02fe1ec7b77a9f3598a72a372 (diff)
parent213cb2c24306e198e717fc162806201567666f36 (diff)
Merge remote-tracking branch 'refs/remotes/jackhumbert/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.