You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

48 lines
1.6 KiB

  1. # MechMerlin's Userspace v0.2.0
  2. This is a collection of my most commonly used QMK features.
  3. A majority of my keyboards are smaller than 75%, ANSI, and staggered.
  4. ## Layers
  5. ----
  6. ### _BL (Base Layer)
  7. Typical standard QWERTY keymap.
  8. ### _FL (Function Layer)
  9. This layer is commonly accessed via `MO(_FL)` on the base layer. It consists of your typical function key F1 through F12 and some RGB and Backlight controls.
  10. ### _AL (Arrow Layer)
  11. This layer is only present on my 60% boards. I habitually use the bottom right modifiers as arrows.
  12. ### _CL (Control Layer)
  13. This is not defined in here as it's present only on `LAYOUT_66` boards, or to be specific, my clueboard. It currently uses the default clueboard controls.
  14. ## Custom Keycodes
  15. ----
  16. ### KC_FNX (Fn Extended)
  17. `KC_FNX` functions as a hold for `MO(X)` and tap for `TG(Y)`. Layer X and Y are different layers.
  18. It is used primarily on my `LAYOUT_60_ansi` boards as my regular toggle (the 1u key to the right of right shift), is not present there.
  19. ### KC_CTCP (Control Caps)
  20. This is just a wrapper for `CTL_T(KC_CAPS)`. This is a hold for control and tap for caps lock.
  21. ## QMK Features
  22. ----
  23. ### RGBLIGHT_SLEEP
  24. Ensures that when my computer is in sleep mode, the keyboard underglow lights will also be off.
  25. ### Audio Clicky
  26. If a board has a speaker, enable beeps and boops per switch actuation. This is currently only available on prototype/gen1 clueboard 66_hotswaps.
  27. ### Velocikey
  28. [Velocikey](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_velocikey.md) is an RGBLIGHT feature in which the faster you type, the faster the ARE GEE BEES.