diff options
| author | leah-splitkb <103112489+leah-splitkb@users.noreply.github.com> | 2022-10-13 05:06:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-13 14:06:18 +1100 |
| commit | a8df5fd3031e97a43c1577e31af6c066bf66b712 (patch) | |
| tree | 3b05db2c5b6a7beec045deabe4dc3388c4c30bf7 /keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md | |
| parent | a195f78200a40f2065b0bf75271fabbb7d381385 (diff) | |
[Keyboard] Add splitkb.com's Aurora Sweep (#18691)
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 + + + +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. |