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.7 KiB

  1. # Overview
  2. My QMK home. I feel as though I stand on the shoulders of giants, for a lot of my code here is borrowed and adapted from so many contributors here, and that I hope my code here can help or inspire others.
  3. ## Layers, Handlers, and Macros
  4. ### Layers
  5. I have some predefined layer names for keyboards:
  6. * **_BASE**: Default Layer, QWERTY layout.
  7. * **_FN1**: Function Layer for 60% and above, and additional macros and shortcuts on 50% and below.
  8. * **_LOWER** and **_RAISE**: Function layers for 40%
  9. and macropads:
  10. * **_REEDER**: Shortcuts for [Reeder.app](https://reederapp.com/), my RSS feed reader
  11. * **_MEDIA**: Media controls
  12. * **_NAVI**: Navigation macros, for changing tabs and scrolling
  13. * **_KARABINER**: Generic macro keys, meant to be customized per app with [Karabiner](https://pqrs.org/osx/karabiner/)
  14. #### Protected Layers
  15. I have some named "protected" layers, meant to be at the end of the layer list for changing keyboard settings and features.
  16. * **KEYMAP_LAYERS**: Add additional layers in keymap.
  17. * **_AUDIO**: Audio feature controls.
  18. * **_LIGHT**: RGB Light/Matrix feature controls.
  19. * **_ADJUST**: General keyboard settings and toggles. Can also contain RGB and Audio controls on larger boards that don't need and extra layer for those controls.
  20. ### EEPROM User Config
  21. I have a custom userspace config implemented to save settings on the board to persist across shutdowns. I currently store:
  22. * rgb_layer_change - a toggle for using RGB themes for layer indication
  23. * rgb_theme - a pointer to the currently set RGB Theme
  24. ### Process Handlers
  25. ### Keycode Aliases
  26. I am a macOS user and so a lot of my aliases are
  27. ### Macros
  28. ## Tap Dances
  29. ### Tap Dance Trigger Layer
  30. ## RGB
  31. ### RGB Theme