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

diff --git a/layouts/community/60_ansi/mechmerlin-ansi/keymap.c b/layouts/community/60_ansi/mechmerlin-ansi/keymap.c
index e48fddea46c49154d792810632d66a94e1edb94e..4128c4cf2d46d13dd1b55d987d73c87065a49611 100644 (file)
--- a/layouts/community/60_ansi/mechmerlin-ansi/keymap.c
+++ b/layouts/community/60_ansi/mechmerlin-ansi/keymap.c
@@ -20,7 +20,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, \
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  \
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  \
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_UP, \
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RSFT_T(KC_UP), \
     KC_TRNS, KC_TRNS, KC_TRNS,       KC_TRNS,                               KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT)
 
  };

diff --git a/layouts/community/60_ansi_split_bs_rshift/mechmerlin-split/keymap.c b/layouts/community/60_ansi_split_bs_rshift/mechmerlin-split/keymap.c
index 5ec005162f43e7b9b2f7a3e54dd4db77d89ab2a0..2464dcaa7091ca977cf2d8e77a015f8bbe73ebba 100644 (file)
--- a/layouts/community/60_ansi_split_bs_rshift/mechmerlin-split/keymap.c
+++ b/layouts/community/60_ansi_split_bs_rshift/mechmerlin-split/keymap.c
@@ -20,7 +20,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_NO, KC_TRNS, \
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  \
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  \
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_UP,   KC_TRNS, \
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RSFT_T(KC_UP),   KC_TRNS, \
     KC_TRNS, KC_TRNS, KC_TRNS,       KC_TRNS,                               KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT)
 
  };

diff --git a/users/mechmerlin/changelog.md b/users/mechmerlin/changelog.md
new file mode 100644 (file)
index 0000000..11b3ba7
--- /dev/null
+++ b/users/mechmerlin/changelog.md
@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to my userspace will be documented in this file.
+
+## [0.1.1] - 2018-10-26
+### Added
+- Added a changelog, aka THIS VERY FILE! 
+- Added `config.h` to userspace for `RGBLIGHT_SLEEP` feature. 
+
+### Changed
+- Spruced up the readme file to better explain the things I use in my keymap for would be keymap snoopers. Also useful as an example when people ask. 
+- Use `CTL_T` instead of `MT` for my custom `KC_CTCP` keycode as it was causing issues on some boards. 
+
+## [0.1.0] - 2018-08-31
+Initial usage of userspaces!

diff --git a/users/mechmerlin/config.h b/users/mechmerlin/config.h
new file mode 100644 (file)
index 0000000..3d58c23
--- /dev/null
+++ b/users/mechmerlin/config.h
@@ -0,0 +1,5 @@
+#pragma once
+
+#ifdef RGBLIGHT_ENABLE
+#define RGBLIGHT_SLEEP
+#endif // RGBLIGHT_ENABLE

diff --git a/users/mechmerlin/mechmerlin.h b/users/mechmerlin/mechmerlin.h
index c140ac70c94636fe2cba7e566ff83df883405f47..6b4d50edc841833bbef8217938ce9a9046b761b8 100644 (file)
--- a/users/mechmerlin/mechmerlin.h
+++ b/users/mechmerlin/mechmerlin.h
@@ -10,8 +10,8 @@ enum userspace_layers {
 
 // Enum of custom keycodes defined in process_record_user
 enum keycodes {
-    KC_FNX, // Hold for FN layer, tap to toggle ARROWS layer. 
+    KC_FNX, // Hold for FN layer, tap to toggle ARROWS layer.
 };
 
 // Custom #defined keycodes
-#define KC_CTCP MT(KC_LCTL, KC_CAPS)
+#define KC_CTCP CTL_T(KC_CAPS)

diff --git a/users/mechmerlin/readme.md b/users/mechmerlin/readme.md
index 6a76dd2a9dd118570b96f22859714c095ffd0c95..1e86a64107fc94d123119fb54a63b94a4f4d894a 100644 (file)
--- 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.