summaryrefslogtreecommitdiff
path: root/keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
diff options
context:
space:
mode:
authorharveysch <126267034+harveysch@users.noreply.github.com>2023-09-15 20:34:21 +0200
committerGitHub <noreply@github.com>2023-09-15 11:34:21 -0700
commite7ae5ec07c7655e0087c6a4cfcb2cbfec4713536 (patch)
treeba0b041c136d3636ebd9288c6a26c00a4feb7168 /keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
parent49f1cbd40eae67cde4c5fb03fe8c0db1e9522956 (diff)
[Keyboard] Add splitkb.com's Aurora Helix (#21871)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/splitkb/aurora/helix/keymaps/debug/readme.md')
-rw-r--r--keyboards/splitkb/aurora/helix/keymaps/debug/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/splitkb/aurora/helix/keymaps/debug/readme.md b/keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
new file mode 100644
index 0000000000..827235e447
--- /dev/null
+++ b/keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
@@ -0,0 +1,24 @@
+# Aurora Helix's Debug Keymap
+
+To make debugging your build as easy as possible, we have provided a special debugging keymap. It is not intended to actually type on, it is just here to make sure that your hardware is working correctly.
+
+## Keys
+
+![Keys](https://raw.githubusercontent.com/splitkb/qmk_firmware/assets/aurora/keymaps/debug/keys.png)
+
+The left side uses lowercase letters, the right side uses uppercase ones.
+
+## Encoders
+
+Encoders output a number of 0 or 1, depending on the installed position.
+These correspond to the index used for custom encoder code: the left half uses index 0, the right half uses index 1.
+
+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. \ No newline at end of file