summaryrefslogtreecommitdiffstats
path: root/users/mechmerlin/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-10-27 02:14:50 +0200
committerDrashna Jaelre <drashna@live.com>2018-10-27 02:14:50 +0200
commitb11a776cef1d5e26e435ed6b4a12711c965abeb6 (patch)
tree7df0da1fbb1488ebaf7eabb46bf8f1bb1e56afe9 /users/mechmerlin/readme.md
parent6fa3cfbf534b54290f693dc1986437aebd092b32 (diff)
downloadqmk_firmware-b11a776cef1d5e26e435ed6b4a12711c965abeb6.tar.gz
qmk_firmware-b11a776cef1d5e26e435ed6b4a12711c965abeb6.tar.xz
Keymap: Update userspace (I want my Hacktoberfest shirt!) (#4252)
* use ctl_t * spruce up readme and add a changelog * add comment about using CTL_T * add more description * use RSFT_T so I can still have a right shift key even on the _AL layer * add config.h for rgblight_sleep * update readme to talk about rgblight_sleep * update changelog with new changes
Diffstat (limited to 'users/mechmerlin/readme.md')
-rw-r--r--users/mechmerlin/readme.md41
1 files changed, 39 insertions, 2 deletions
diff --git a/users/mechmerlin/readme.md b/users/mechmerlin/readme.md
index 6a76dd2a9..1e86a6410 100644
--- a/users/mechmerlin/readme.md
+++ b/users/mechmerlin/readme.md
@@ -1,3 +1,40 @@
-# MechMerlin's Userspace
+# MechMerlin's Userspace v0.1.1
-This is a collection of my most commonly used QMK functions
+This is a collection of my most commonly used QMK features.
+
+A majority of my keyboards are smaller than 75%, ANSI, and staggered.
+
+## Layers
+----
+
+### _BL (Base Layer)
+Typical standard QWERTY keymap.
+
+### _FL (Function Layer)
+This layer is commonly accessed via `MO(_FL)` on the base layer. It consists of your typical function key F1 through F12 and some RGB and Backlight controls.
+
+### _AL (Arrow Layer)
+This layer is only present on my 60% boards. I habitually use the bottom right modifiers as arrows.
+
+### _CL (Control Layer)
+This is not defined in here as it's present only on `LAYOUT_66` boards, or to be specific, my clueboard. It currently uses the default clueboard controls.
+
+## Custom Keycodes
+----
+
+### KC_FNX (Fn Extended)
+
+`KC_FNX` functions as a hold for `MO(X)` and tap for `TG(Y)`. Layer X and Y are different layers.
+
+It is used primarily on my `LAYOUT_60_ansi` boards as my regular toggle (the 1u key to the right of right shift), is not present there.
+
+### KC_CTCP (Control Caps)
+
+This is just a wrapper for `CTL_T(KC_CAPS)`. This is a hold for control and tap for caps lock.
+
+## QMK Features
+----
+
+### RGBLIGHT_SLEEP
+
+Ensures that when my computer is in sleep mode, the keyboard underglow lights will also be off.