search

arduino-libraries / Keyboard

GNU Lesser General Public License v3.0
223 stars 157 forks source link

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

Open skhrlx opened 1 year ago

skhrlx commented 1 year ago

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

per1234 commented 1 year ago

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.

edgar-bonet commented 1 year ago

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?