Skip to content
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

How i can create my own layout for my keyboard? #79

Open
skhrlx opened this issue Nov 1, 2022 · 2 comments
Open

How i can create my own layout for my keyboard? #79

skhrlx opened this issue Nov 1, 2022 · 2 comments
Assignees
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@skhrlx
Copy link

skhrlx commented Nov 1, 2022

This can help a lot of people and maybe the people will stop making issues for add new languages...

@per1234
Copy link
Contributor

per1234 commented Nov 1, 2022

Hi @skhrlx. The information is available here:

https://github.com/arduino-libraries/Keyboard/blob/master/src/KeyboardLayout.h

As for making that information more discoverable, I'm not sure it would make sense to move it to Arduino's more visible user-targeted "tutorials" content. However, I do think it would be reasonable to add a note linking to the current documentation in src/KeyboardLayout.h in the library's readme:

https://github.com/arduino-libraries/Keyboard/blob/master/README.adoc

If you think that would be helpful, you are welcome to submit a pull request. Or if you think the existing documentation is sufficient then please let me know.

@per1234 per1234 self-assigned this Nov 1, 2022
@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Nov 1, 2022
@edgar-bonet
Copy link
Collaborator

There is actually a note at the bottom of the documentation of Keyboard.begin():

Notes and Warnings

Custom layouts can be created by copying and modifying an existing layout. See the instructions in the Keyboard library’s KeyboardLayout.h file.

I've put it in this page because that's where the layouts are mentioned. You may want to check this discussion about the proper way to document this possibility.

If a more prominent note is desirable, maybe the top page of the library's documentation would be appropriate?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

3 participants