summaryrefslogtreecommitdiffstats
path: root/keyboards/clueboard/keymaps/smt/readme.md
diff options
context:
space:
mode:
authorStephen Tudor <smt@smt.io>2017-05-08 18:32:15 -0400
committerskullydazed <skullydazed@users.noreply.github.com>2017-05-08 15:32:15 -0700
commit9a8904a9c071730ef6712f8be93c38ac4b43fbdb (patch)
tree589da78410eed5f89f80516fb5401a357e20d2a1 /keyboards/clueboard/keymaps/smt/readme.md
parent153eb95ab208cf5563ce2fae7ec68981b64d11ce (diff)
Add smt keymap for Clueboard (HHKB-style layout) (#1286)
* Add keymap for smt Clueboard (HHKB layout) * Add readme for smt Clueboard (HHKB) keymap * Flesh out the keymap a bit more to support Colemak & Dvorak * Update README with layout image
Diffstat (limited to 'keyboards/clueboard/keymaps/smt/readme.md')
-rw-r--r--keyboards/clueboard/keymaps/smt/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/clueboard/keymaps/smt/readme.md b/keyboards/clueboard/keymaps/smt/readme.md
new file mode 100644
index 0000000000..6a8b3edb44
--- /dev/null
+++ b/keyboards/clueboard/keymaps/smt/readme.md
@@ -0,0 +1,30 @@
+```
+ ___ _____ _ _ _ __ __ _ __
+|__ \ / ____| | | | | | / / / /(_) / /
+ ||) | | | | |_ _ ___| |__ ___ __ _ _ __ __| | / /_ / /_ / /
+ |/ / | | | | | | |/ _ \ '_ \ / _ \ / _` | '__/ _` | | '_ \| '_ \ / /
+ |_| | |____| | |_| | __/ |_) | (_) | (_| | | | (_| | | (_) | (_) / / _
+ (_) \_____|_|\__,_|\___|_.__/ \___/ \__,_|_| \__,_| \___/ \___/_/ (_)
+```
+
+# smt Clueboard Layout (HHKB variant)
+
+![Clueboard Layout Image](layout.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/