[Keymap] Converted stanrc85 community layout to userspace (#5244)

[qmk_firmware.git] / users / stanrc85 / readme.md

diff --git a/users/stanrc85/readme.md b/users/stanrc85/readme.md
new file mode 100644 (file)
index 0000000..9009a71
--- /dev/null
+++ b/users/stanrc85/readme.md
@@ -0,0 +1,52 @@
+<!-- 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.
+
+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
+
+Shared keymap between two 60% PCB:
+- 1upkeyboards60HSE
+- DZ60 (hotswap)
+
+## Keymap Notes
+- 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 Underglow control and RESET
+    - `Fn2+CAPS` used to toggle Default QWERTY layer on and off
+
+![RGB and RESET Layer](https://imgur.com/PyB8z7k.png)
+
+### Build
+To build the firmware file associated with this keymap, simply run `make your_keyboard:stanrc85-ansi`.