aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authorGravatar Didier Loiseau <didierloiseau+git@gmail.com>2016-09-11 01:26:47 +0200
committerGravatar Didier Loiseau <didierloiseau+git@gmail.com>2016-09-11 01:26:47 +0200
commitb9014c757599ca288be07629ad1d00ef66c033f1 (patch)
treeba056e704e76327c597e25d1be200c4c991efeb8 /keyboards/ergodox/keymaps/twey/readme.md
parent60a826923d5a6b0dbe416b0837608149ab82e470 (diff)
parent5010df3d8b68a53c382b853c7c2e45922975b631 (diff)
downloadqmk_firmware-b9014c757599ca288be07629ad1d00ef66c033f1.tar.gz
Merge remote-tracking branch 'remotes/jackhumbert/master' into bépo
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.