summaryrefslogtreecommitdiff
path: root/keyboards/clueboard/66/keymaps/smt/readme.md
diff options
context:
space:
mode:
authorskullydazed2017-10-17 18:05:21 -0700
committerGitHub2017-10-17 18:05:21 -0700
commit3f3fa0791895f14370b4bb3e8512597688c45122 (patch)
treeac5672833f0d3a0d91798401d2ff3caa560904b2 /keyboards/clueboard/66/keymaps/smt/readme.md
parentad49db8cd2557b6c54531059d4d162623520bd17 (diff)
Reorganize clueboard into a single directory (#1855)
Diffstat (limited to 'keyboards/clueboard/66/keymaps/smt/readme.md')
-rw-r--r--keyboards/clueboard/66/keymaps/smt/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/clueboard/66/keymaps/smt/readme.md b/keyboards/clueboard/66/keymaps/smt/readme.md
new file mode 100644
index 000000000..7fc0f0248
--- /dev/null
+++ b/keyboards/clueboard/66/keymaps/smt/readme.md
@@ -0,0 +1,21 @@
+# smt Clueboard Layout (HHKB variant)
+
+![Clueboard Layout Image](http://i.imgur.com/Ll5gGte.png)
+
+This is smt's HHKB variant layout, based on the default layout that comes
+flashed on every Clueboard. The primary differences from the default are:
+
+- The Backspace key is moved down into the traditional `\` position
+- `\` and `` ` `` are assigned to the "split-backspace" positions
+- The right Shift is split to allow for a Fn key to its right
+- The modifiers on the right side now mirror the left side (`Alt`/`Super`/`Ctrl`)
+
+For the most part, it's a straightforward and easy to follow layout. There
+are a few special keys:
+
+- The Esc key sends `Esc` when tapped, `` ` `` when `Alt`/`Super`/`Ctrl`/`Fn` is held, or `~` when `Shift` is held
+- The Tab key sends `Tab` when tapped, or `Super+Ctrl+Alt+Shift` (a.k.a. [Hyper]) when held
+- The key traditionally in the Caps-Lock position has been re-mapped to send `Esc` when tapped, or `Ctrl` when held
+- The left Shift key sends `Enter` when tapped, or `Shift` when held
+
+[Hyper]: http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/