diff options
author | Joel Challis <git@zvecr.com> | 2023-12-18 21:55:36 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-12-19 08:55:36 +1100 |
commit | fc4e6c61a44756a1dc2ac6ef8f98a5159f903635 (patch) | |
tree | 3a8a2fc96abe60b4c3d476fe7647a1913404f371 /keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md | |
parent | a1c8b1ebf724f79dd9bad12976e3b1bd0c9c196f (diff) |
[Keymap Removal] Restore splitkb 'debug' keymaps (#22700)
Diffstat (limited to 'keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md')
-rw-r--r-- | keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md b/keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md new file mode 100644 index 0000000000..8c51d64842 --- /dev/null +++ b/keyboards/splitkb/aurora/lily58/keymaps/debug/readme.md @@ -0,0 +1,24 @@ +# Aurora Lily58'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://i.imgur.com/CF0PYu5h.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. |