Update joystick.md - Githubissues

qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families

https://qmk.fm

GNU General Public License v2.0

17.48k stars 37.73k forks source link

Update joystick.md #23928

Open arminAnderson opened 2 weeks ago

arminAnderson commented 2 weeks ago

Explicit note about compatibility with ARM boards and the ADC driver

Description

Types of Changes

[ ] Core
[ ] Bugfix
[ ] New feature
[ ] Enhancement/optimization
[ ] Keyboard (addition or update)
[ ] Keymap/layout/userspace (addition or update)
[x] Documentation

Issues Fixed or Closed by This PR

Checklist

[x] My code follows the code style of this project: C, Python
[x] I have read the PR Checklist document and have made the appropriate changes.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[x] I have added tests to cover my changes.
[x] I have tested the changes and verified that they work and don't break anything (as well as I can manage).

arminAnderson commented 2 weeks ago

I spent around 3 hours trying to figure out why only one axis was working on my joystick, before noticing the comment on the ADC driver doc. I feel explicitly calling out this compatibility on the joystick doc itself could be useful