summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authorJason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
committerJason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
commitfc2ca62a3b9552175eb7c27cc11f3a5af6cfae50 (patch)
tree59b2f2406f472a9fd2af4946420d1a1c880929c0 /keyboards/ergodox/keymaps/twey/readme.md
parenta41a7a9100b9f4c6bfdf49b39b05e626ffd95397 (diff)
parent8e00c464e6f488d86e0768a77a2ad5ee238dba6d (diff)
Merge branch 'master'
Conflicts: keyboards/planck/keymaps/bone2planck/keymap.c
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.