[Keymap] Keymap and readme updates (qmk#5449)

* Remove tap dance code from keymap.c * Add tap dance code to userspace files * Readme updates * Update keymap images
ojiry · Mar 20, 2019 · 6e7eff4 · 6e7eff4
1 parent 4b4eba9
commit 6e7eff4
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 31 deletions.
diff --git a/keyboards/hs60/v2/keymaps/stanrc85/keymap.c b/keyboards/hs60/v2/keymaps/stanrc85/keymap.c
@@ -16,17 +16,6 @@
 #include QMK_KEYBOARD_H
 #include "stanrc85.h"
 
-//Tap Dance Declarations
-enum {
-	TD_WIN = 0,
-	TD_ESC
-};
-
-qk_tap_dance_action_t tap_dance_actions[] = {
-	[TD_WIN] = ACTION_TAP_DANCE_DOUBLE(KC_CAD, KC_LOCK),
-	[TD_ESC] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_GRV)
-};
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	[0] = LAYOUT_60_ansi(
 		TD_TESC, KC_1,    KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,

diff --git a/keyboards/hs60/v2/keymaps/stanrc85/readme.md b/keyboards/hs60/v2/keymaps/stanrc85/readme.md
@@ -42,7 +42,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.-->
 - Layer 3 is Backlight control and RESET
     - `Fn2+CAPS` used to toggle Default QWERTY layer on and off
 
-![RGB and RESET Layer](https://imgur.com/1ScpRE4.png)
+![RGB and RESET Layer](https://imgur.com/mMHoJPa.png)
 
 ### Build
 To build the firmware file associated with this keymap, simply run `make your_keyboard:stanrc85`.
diff --git a/layouts/community/60_ansi/stanrc85-ansi/keymap.c b/layouts/community/60_ansi/stanrc85-ansi/keymap.c
@@ -16,17 +16,6 @@
 #include QMK_KEYBOARD_H
 #include "stanrc85.h"
 
-//Tap Dance Declarations
-enum {
-	TD_WIN = 0,
-	TD_ESC
-};
-
-qk_tap_dance_action_t tap_dance_actions[] = {
-	[TD_WIN] = ACTION_TAP_DANCE_DOUBLE(KC_CAD, KC_LOCK),
-	[TD_ESC] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_GRV)
-};
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	[0] = LAYOUT_60_ansi(
 		TD_TESC, KC_1,    KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,

diff --git a/layouts/community/60_ansi/stanrc85-ansi/readme.md b/layouts/community/60_ansi/stanrc85-ansi/readme.md
@@ -1,14 +1,48 @@
-# Stanrc85's Standard ANSI 60% Layout
+<!-- Copyright 2019 Stanrc85
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-Shared keymap between two 60% PCB:
-- 1upkeyboards60HSE
-- DZ60 (hotswap)
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.-->
+
+# Stanrc85's Standard ANSI 60% Layout
 
 ## Keymap Notes
-- Layer 0 is custom ANSI layout with SpaceFN, CTRL/ESC on CAPS, Tap Dance on Fn1 key for CTRL+ALT+DEL and WIN+L
-- Layer 1 is default ANSI (enable with Fn2+D)
-- Layer 2 is F keys, arrows, volume controls and custom shortcuts for AHK
-- Layer 3 is RGB Underglow control and RESET
+- Layer 0 is default QWERTY layout with additional custom features:
+    - SpaceFN to function layer 2 on `Space`
+    - `CTRL` when held and `ESC` when tapped on `CAPS LOCK`
+    - Tap Dance on `Fn1` for `CTRL+ALT+DEL` and `WIN+L`
+    - Tap Dance on `ESC` for `ESC` and  ` ` `
+
+![Base QWERTY Layer](https://imgur.com/lGcyLJx.png)
+
+- Layer 1 is default QWERTY with no custom features used mostly for gaming
+    - Enabled by `Fn2+CAPS` from base layer
+
+![Default ANSI Layer](https://imgur.com/M7T9PNT.png)
+
+- Layer 2 is Function layer:
+    - F keys
+    - Arrows
+    - Volume and Media controls
+    - AutoHotkey shortcuts based on [Speaker Control](https://github.com/stanrc85/Speaker-Control) script
+        - AHK Mic is used to mute/unmute microphone
+        - AHK Speaker switches audio output between headphones and speakers
+
+![Function Layer](https://imgur.com/YPl0JrU.png)
+
+- Layer 3 is RGB control and RESET
+    - `Fn2+CAPS` used to toggle Default QWERTY layer on and off
+
+![RGB and RESET Layer](https://imgur.com/8K7gSgh.png)
 
 ### Build
 To build the firmware file associated with this keymap, simply run `make your_keyboard:stanrc85-ansi`.
diff --git a/users/stanrc85/stanrc85.c b/users/stanrc85/stanrc85.c
@@ -5,6 +5,11 @@ bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
   return true;
 }
 
+qk_tap_dance_action_t tap_dance_actions[] = {
+	[TD_WIN] = ACTION_TAP_DANCE_DOUBLE(KC_CAD, KC_LOCK),
+	[TD_ESC] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_GRV)
+};
+
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   switch (keycode) {
   case KC_MAKE:

diff --git a/users/stanrc85/stanrc85.h b/users/stanrc85/stanrc85.h
@@ -13,6 +13,12 @@ enum custom_keycodes {
   NEW_SAFE_RANGE  //use "NEW_SAFE_RANGE" for keymap specific codes
 };
 
+//Tap Dance Declarations
+enum {
+	TD_WIN = 0,
+	TD_ESC
+};
+
 //Aliases for longer keycodes
 #define KC_CAD	LALT(LCTL(KC_DEL))
 #define KC_LOCK	LGUI(KC_L)