summaryrefslogtreecommitdiff
path: root/keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md')
-rw-r--r--keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md25
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.