users/stanrc85/readme.md

   1 <!-- Copyright 2019 Stanrc85
   2
   3 This program is free software: you can redistribute it and/or modify
   4 it under the terms of the GNU General Public License as published by
   5 the Free Software Foundation, either version 2 of the License, or
   6 (at your option) any later version.
   7
   8 This program is distributed in the hope that it will be useful,
   9 but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 GNU General Public License for more details.
  12
  13 You should have received a copy of the GNU General Public License
  14 along with this program.  If not, see <http://www.gnu.org/licenses/>.-->
  15
  16 # Stanrc85's Standard ANSI 60% Layout
  17
  18 Shared keymap between two 60% PCB:
  19 - 1upkeyboards60HSE
  20 - DZ60 (hotswap)
  21
  22 ## Keymap Notes
  23 - Layer 0 is default QWERTY layout with additional custom features:
  24     - SpaceFN to function layer 2 on `Space`
  25     - `CTRL` when held and `ESC` when tapped on `CAPS LOCK`
  26     - Tap Dance on `Fn1` for `CTRL+ALT+DEL` and `WIN+L`
  27     - Tap Dance on `ESC` for `ESC` and  ` ` `
  28
  29 ![Base QWERTY Layer](https://imgur.com/lGcyLJx.png)
  30
  31 - Layer 1 is default QWERTY with no custom features used mostly for gaming
  32     - Enabled by `Fn2+CAPS` from base layer
  33
  34 ![Default ANSI Layer](https://imgur.com/M7T9PNT.png)
  35
  36 - Layer 2 is Function layer:
  37     - F keys
  38     - Arrows
  39     - Volume and Media controls
  40     - AutoHotkey shortcuts based on [Speaker Control](https://github.com/stanrc85/Speaker-Control) script
  41         - AHK Mic is used to mute/unmute microphone
  42         - AHK Speaker switches audio output between headphones and speakers
  43
  44 ![Function Layer](https://imgur.com/YPl0JrU.png)
  45
  46 - Layer 3 is RGB Underglow control and RESET
  47     - `Fn2+CAPS` used to toggle Default QWERTY layer on and off
  48
  49 ![RGB and RESET Layer](https://imgur.com/PyB8z7k.png)
  50
  51 ### Build
  52 To build the firmware file associated with this keymap, simply run `make your_keyboard:stanrc85-ansi`.