diff options
author | QMK Bot <hello@qmk.fm> | 2022-10-13 03:06:56 +0000 |
---|---|---|
committer | QMK Bot <hello@qmk.fm> | 2022-10-13 03:06:56 +0000 |
commit | 563a59d3c732a4fdf4ef256b07b1e92c8951a032 (patch) | |
tree | a732b3b3af1fb6874cf84d469ad66f7f14f0c797 /keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md | |
parent | 14b522bb34df9fa9a7f1c8857434518e35d3a312 (diff) | |
parent | a8df5fd3031e97a43c1577e31af6c066bf66b712 (diff) |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md')
-rw-r--r-- | keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md b/keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md new file mode 100644 index 0000000000..6d4d5aaff6 --- /dev/null +++ b/keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md @@ -0,0 +1,25 @@ +# Aurora Sweep's Debug Keymap + +Due to the complex layer setup, the default keymap for the Aurora Sweep is relatively hard to debug. +This debug keymap should make that a lot easier. + +## Keys + +![Keys](https://raw.githubusercontent.com/splitkb/qmk_firmware/assets/aurora/sweep/keymaps/debug/keys.png) + +The left side uses lowercase letters, the right side uses uppercase ones. + +## Encoders + +Encoders output a number of 0 to 3, depending on the installed position. +These correspond to the index used for custom encoder code. + +The number is followed by either a `+` or a `-`, depending on the direction turned. + +## LEDs + +Both underglow and per-key RGB should be fading between red and off. + +## OLEDs + +Both the primary and secondary side should be filled with characters. |