aboutsummaryrefslogtreecommitdiff
path: root/layouts/community/alice/stanrc85-alice/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'layouts/community/alice/stanrc85-alice/readme.md')
-rw-r--r--layouts/community/alice/stanrc85-alice/readme.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/layouts/community/alice/stanrc85-alice/readme.md b/layouts/community/alice/stanrc85-alice/readme.md
new file mode 100644
index 000000000..3c4d7ffc3
--- /dev/null
+++ b/layouts/community/alice/stanrc85-alice/readme.md
@@ -0,0 +1,57 @@
1<!-- Copyright 2021 Stanrc85
2
3This program is free software: you can redistribute it and/or modify
4it under the terms of the GNU General Public License as published by
5the Free Software Foundation, either version 2 of the License, or
6(at your option) any later version.
7
8This program is distributed in the hope that it will be useful,
9but WITHOUT ANY WARRANTY; without even the implied warranty of
10MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License
14along with this program. If not, see <http://www.gnu.org/licenses/>.-->
15
16# Stanrc85's Standard Layout
17
18Shared keymap between 60%, 65%, Alice layouts:
19- 1upkeyboards60HSE
20- Mark65
21- Sneakbox Alice
22
23## Keymap Notes
24- Layer 0 is default QWERTY layout with additional custom features:
25 - SpaceFN to function layer 2 on `Space`
26 - `CTRL` when held and `ESC` when tapped on `CAPS LOCK`
27 - Tap Dance on `Fn1` for `CTRL+ALT+DEL` and `WIN+L`
28 - Tap Dance on `ESC` for `ESC` and ` ` `
29
30![Base QWERTY Layer](https://imgur.com/SrLWaoj.png)
31
32- Layer 1 is default QWERTY with no custom features used mostly for gaming
33 - Enabled by `Fn2+RCTL` from base layer
34
35![Default ANSI Layer](https://imgur.com/KMxFZ2v.png)
36
37- Layer 2 is Function layer:
38 - F keys
39 - Arrows
40 - Volume and Media controls
41 - AutoHotkey shortcuts based on [Speaker Control](https://github.com/stanrc85/Speaker-Control) script
42 - AHK Mic is used to mute/unmute microphone
43 - AHK Speaker switches audio output between headphones and speakers
44
45![Function Layer](https://imgur.com/Luqo4cg.png)
46
47- Layer 3 is RGB Underglow control and RESET
48 - `Fn2+RCTL` used to toggle Default QWERTY layer on and off
49 - `qmk compile` command on `Fn2+Enter`
50 - `qmk flash` command on `Fn2+Shift+enter`
51
52![RGB and RESET Layer](https://imgur.com/tlpoP5E.png)
53
54
55
56### Build
57To build the firmware file associated with this keymap, simply run `make your_keyboard:stanrc85-alice`. \ No newline at end of file