-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: added a page on dongles #2525
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be good to add a pointer from split keyboards feature page to here, saying it is also used for creating "dongles".
I think this is well written overall. As a side note, it is a bit too prescriptive for my taste (do this, then do this, rather than explaining how the config works) but given the current complexity of the setup it seems unavoidable, assuming we do want to document how to do it.
This was intentional, since we keep getting people asking for help setting up a dongle for their keyboard who have not done the whole shield porting thing. I see the dongle setup as just a highly simplified and prescriptive version of the shield docs. I'll adjust to refer readers to the shield guide a bit stronger if they want to understand any details. |
Co-authored-by: rasmuskoit <rasmuskoit@gmail.com> Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Added a page on configuring dongles, building on the work that @RasmusKoit did in #2401. The method recommended is personal to each user, but works for both boards and shield based keyboards (requires a board for the dongle, to avoid users messing with flash etc).
Subsumes #2401, closes #2044.
EDIT: I am waiting until #2537 to make some changes.