summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authorCallum Oakley <c.oakley108@gmail.com>2016-08-09 12:39:59 +0100
committerCallum Oakley <c.oakley108@gmail.com>2016-08-09 12:39:59 +0100
commit49fbcb3e7cea2d47df6350918ff6e00960a78b15 (patch)
tree468105b030bd61b3c12c1b93784ff38334113355 /keyboards/ergodox/keymaps/twey/readme.md
parent725dd7328f9963959f72318af912ed66f5a5f513 (diff)
parentadad05c3fbd511e77a77484945fa2f675d6abf8b (diff)
downloadqmk_firmware-49fbcb3e7cea2d47df6350918ff6e00960a78b15.tar.gz
qmk_firmware-49fbcb3e7cea2d47df6350918ff6e00960a78b15.zip
Merge remote-tracking branch 'upstream/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 0000000000..979e4261e5
--- /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.