summaryrefslogtreecommitdiff
path: root/users/drashna/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/drashna/readme.md')
-rw-r--r--users/drashna/readme.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/users/drashna/readme.md b/users/drashna/readme.md
index 0523be2a6..e77948ea9 100644
--- a/users/drashna/readme.md
+++ b/users/drashna/readme.md
@@ -4,19 +4,26 @@ Overview
This is my personal userspace file. Most of my code exists here, as it's heavily shared.
-Custom handlers
----------------
+Custom userspace handlers
+-------------------------
+
+Specifically QMK works by using customized handlers for everything. This allows for multiple levels of customization.
+
+`matrix_scan` calls `matrix_scan_quantum`, which alls `matrix_scan_kb`, which calls `matrix_scan_user`.
+`process_record` calls a bunch of stuff, but eventually calls `process_record_kb` which calls `process_record_user`
+The same goes for `matrix_init`, `layer_state_set`, `led_set`, and a few other functions.
All (most) `_user` functions are handled here instead. To allow keyboard specific configuration, I've created `_keymap` functions that can be called by the keymap.c files instead.
This allows for keyboard specific configuration while maintaining the ability to customize the board.
-My Ergodox EZ Keymap is a good example of this, as it uses the LEDs as modifier indicators.
+My [Ergodox EZ Keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/ergodox_ez/keymaps/drashna/keymap.c#L399) is a good example of this, as it uses the LEDs as modifier indicators.
+
Custom Keycodes
---------------
-Keycods are defined in the drashna.h file and need to be included in the keymap.c files, so that they can be used there.
+Keycodes are defined in the drashna.h file and need to be included in the keymap.c files, so that they can be used there.
A bunch of macros are present and are only included on boards that are not the Ergodox EZ or Orthodox, as they are not needed for those boards.