summaryrefslogtreecommitdiffstats
path: root/users/stanrc85/readme.md
diff options
context:
space:
mode:
authorstanrc85 <47038504+stanrc85@users.noreply.github.com>2019-02-26 22:01:46 +0100
committerDrashna Jaelre <drashna@live.com>2019-02-26 22:01:46 +0100
commitbcaf66bd3238b5a69c7ec5910a116c5668e1695c (patch)
tree33005229644c7420b6f3b6ff0a92d4083cdceb30 /users/stanrc85/readme.md
parent11bdf28001382239949541e0442aa170eb561c41 (diff)
downloadqmk_firmware-bcaf66bd3238b5a69c7ec5910a116c5668e1695c.tar.gz
qmk_firmware-bcaf66bd3238b5a69c7ec5910a116c5668e1695c.tar.xz
[Keymap] Converted stanrc85 community layout to userspace (#5244)
* Convert community layout to userspace for future use * Big readme update * Move layer toggle to CAPS * Readme updates * Deleted since unused * Removed call to unused .c file
Diffstat (limited to 'users/stanrc85/readme.md')
-rw-r--r--users/stanrc85/readme.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/users/stanrc85/readme.md b/users/stanrc85/readme.md
new file mode 100644
index 000000000..9009a71d5
--- /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`.