Skip to content

Better layout docs and source #52

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Better layout docs and source #52

wants to merge 12 commits into from

Conversation

thejpster
Copy link
Member

@thejpster thejpster commented Jun 3, 2025

  • Re-works how we do keyboard layouts, using helper functions to simplify each layout.
  • Adds a nice diagram of each layout, and a tool to generate the diagrams
  • Control codes (like Ctrl+C => \U+0003) are now generated from the ASCII letter, avoiding mistakes like the last couple of PRs had to fix

@thejpster thejpster changed the title Draft: better layout docs Better layout docs and source Jun 5, 2025
@thejpster thejpster added the draft label Jun 5, 2025
thejpster added 11 commits June 5, 2025 20:02
So it appears on docs.rs. Leave README for repo-level data.
Using Unicode Literals ('\u{0000}') is more consistent with the diagrams
I am about to add, and forces us to standardise on one notation instead
of a mixture of decimal and hexadecimal.
Now keyboard layouts know their own physical layout.
Also clean up description text - we now longer show raw keys.
Also add one where the Alt key is the same regardless of shift status.
@thejpster thejpster removed the draft label Jun 6, 2025
@thejpster
Copy link
Member Author

OK, I'm done! This is ready to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant