From a8df5fd3031e97a43c1577e31af6c066bf66b712 Mon Sep 17 00:00:00 2001
From: leah-splitkb <103112489+leah-splitkb@users.noreply.github.com>
Date: Thu, 13 Oct 2022 05:06:18 +0200
Subject: [Keyboard] Add splitkb.com's Aurora Sweep (#18691)

---
 .../splitkb/aurora/sweep/keymaps/debug/readme.md   | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md

(limited to 'keyboards/splitkb/aurora/sweep/keymaps/debug/readme.md')

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.
-- 
cgit v1.2.3