]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/clueboard/keymaps/smt/readme.md
Merge remote-tracking branch 'origin/feature/DK60'
[qmk_firmware.git] / keyboards / clueboard / keymaps / smt / readme.md
1 ```
2  ___     _____ _            _                         _     __    __ _   __
3 |__ \   / ____| |          | |                       | |   / /   / /(_) / /
4  ||) | | |    | |_   _  ___| |__   ___   __ _ _ __ __| |  / /_  / /_   / /
5  |/ /  | |    | | | | |/ _ \ '_ \ / _ \ / _` | '__/ _` | | '_ \| '_ \ / /
6  |_|   | |____| | |_| |  __/ |_) | (_) | (_| | | | (_| | | (_) | (_) / / _
7  (_)    \_____|_|\__,_|\___|_.__/ \___/ \__,_|_|  \__,_|  \___/ \___/_/ (_)
8 ```
9
10 # smt Clueboard Layout (HHKB variant)
11
12 ![Clueboard Layout Image](layout.png)
13
14 This is smt's HHKB variant layout, based on the default layout that comes
15 flashed on every Clueboard. The primary differences from the default are:
16
17 - The Backspace key is moved down into the traditional `\` position
18 - `\` and `` ` `` are assigned to the "split-backspace" positions
19 - The right Shift is split to allow for a Fn key to its right
20 - The modifiers on the right side now mirror the left side (`Alt`/`Super`/`Ctrl`)
21
22 For the most part, it's a straightforward and easy to follow layout. There
23 are a few special keys:
24
25 - The Esc key sends `Esc` when tapped, `` ` `` when `Alt`/`Super`/`Ctrl`/`Fn` is held, or `~` when `Shift` is held
26 - The Tab key sends `Tab` when tapped, or `Super+Ctrl+Alt+Shift` (a.k.a. [Hyper]) when held
27 - The key traditionally in the Caps-Lock position has been re-mapped to send `Esc` when tapped, or `Ctrl` when held
28 - The left Shift key sends `Enter` when tapped, or `Shift` when held
29
30 [Hyper]: http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/