summaryrefslogtreecommitdiffstats
path: root/keyboards/clueboard/keymaps/magicmonty/readme.md
diff options
context:
space:
mode:
authorLuiz Ribeiro <luizribeiro@gmail.com>2017-07-04 17:17:28 +0200
committerLuiz Ribeiro <luizribeiro@gmail.com>2017-07-04 17:17:28 +0200
commitd5486265b8afcada68306c815b08c225fce287af (patch)
tree8fb7f8fee4aa3937003bd69d5c77ca867c010d12 /keyboards/clueboard/keymaps/magicmonty/readme.md
parent738b072bb0f25d0369a998c550c369e4f64cc7a5 (diff)
parent34c8bf47a76c8a2dcd3b1a19dd608f8fb2fafb31 (diff)
downloadqmk_firmware-d5486265b8afcada68306c815b08c225fce287af.tar.gz
qmk_firmware-d5486265b8afcada68306c815b08c225fce287af.tar.xz
Merge branch 'master' into ps2avrGB
Diffstat (limited to 'keyboards/clueboard/keymaps/magicmonty/readme.md')
-rw-r--r--keyboards/clueboard/keymaps/magicmonty/readme.md44
1 files changed, 37 insertions, 7 deletions
diff --git a/keyboards/clueboard/keymaps/magicmonty/readme.md b/keyboards/clueboard/keymaps/magicmonty/readme.md
index 2959172df..e24212d04 100644
--- a/keyboards/clueboard/keymaps/magicmonty/readme.md
+++ b/keyboards/clueboard/keymaps/magicmonty/readme.md
@@ -1,18 +1,43 @@
-![Clueboard Layout Image](http://i.imgur.com/ngg4EAY.png)
+# Layout of @magicmonty
+
+[Keyboard Layout Editor File]
+
+![Clueboard Layout Image](http://i.imgur.com/eEwjLEj.png)
+My ClueBoard Layout as of 2017/06/30
-# MouseKeys Layout
This layout is a combination of the `mouse_keys` and the `win_optimized` layouts.
This layout is optimized for an ISO layout.
+The CapsLock is disabled and works as ESC when tapped and FN when held.
+The `TAB` key works as `TAB` when tapped, and [HYPER] (`CTRL` + `ALT` + `SHIFT` + `CMD`) when held.
+
+## Mouse Layer
-It adds a mouse layer. When you hold down the spacebar the arrow keys
-will move your mouse cursor. You can click using the 3 mods to the left of the
-arrow keys, or the 3 keys under your primary fingers on the home row.
+When you hold down the spacebar the arrow keys will move your mouse cursor.
+You can click using the 3 mods to the left of the arrow keys, or the 3 keys under your primary fingers on the home row.
The Left, Down, Up and Right for the mouse movement are also VIM-Like on the HJKL keys
-The CapsLock is disabled and works as Function key.
+## MIDI layer
+
+The MIDI layer is permanently enabled by pressing `FN` + `/`.
+It can be exited with the `ESC`-Key
+
+## Space Cadet(ish) Shift Parentheses
+
+If the function layer is active, the `SHIFT`-Keys are configured like the [Space Cadet Shift Parentheses]
+as opened (left `SHIFT`) and closed (right `SHIFT`) parentheses if tapped and `SHIFT` if held.
-There is also a separate media layer with Volume/Play controls
+## Media layer
+
+The media layer with Volume/Play controls, can be accessed via `FN` + `m`
+
+## Control layer
+
+The control layer is accessed via `FN` + `s`.
+Here one can control the behavior of the RGB underlight.
+`FN` + `s` + `1` resets the RGB underlight to the Layer signalling mode
+
+## Layer signalling through underlight
The different layers are signalled throug setting of the underlight:
@@ -21,3 +46,8 @@ The different layers are signalled throug setting of the underlight:
- Media layer: Green
- Mouse layer: Blue
- Control layer: Red
+- Midi layer: Purple
+
+[HYPER]: http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/
+[Space Cadet Shift Parentheses]: http://stevelosh.com/blog/2012/10/a-modern-space-cadet/#shift-parentheses
+[Keyboard Layout Editor File]: http://www.keyboard-layout-editor.com/#/gists/f869b8789242a712e0f46eabbd550056