summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/twey/readme.md
diff options
context:
space:
mode:
authorFred Sundvik <fsundvik@gmail.com>2016-07-07 22:28:28 +0300
committerFred Sundvik <fsundvik@gmail.com>2016-07-29 20:48:04 +0300
commit9af995c59b2655fa347e43b1eab2122e72ef7fe3 (patch)
treef76ccbd3ab8c911ae851bb83d13173c5755c7162 /keyboards/ergodox/keymaps/twey/readme.md
parent30003d48f9a04676b81bf2980a235106ec7886b0 (diff)
downloadqmk_firmware-9af995c59b2655fa347e43b1eab2122e72ef7fe3.tar.gz
qmk_firmware-9af995c59b2655fa347e43b1eab2122e72ef7fe3.zip
Initial structure for Ergodox as subprojects
Only the EZ default keymaps compiles at the moment though.
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.