Skip to content

Commit

Permalink
dessalines#702 Add layout naming guideline to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mpsijm committed Aug 6, 2024
1 parent da5e866 commit 0d07312
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ I'd be happy to accept additions to add more languages, and layouts. To start:
- Read the letter position guidelines above. This means you'll likely need a letter frequency chart for text written in your language.
- The general rule is: popular vowels on the right, bottom to top, consonants on the left.
- Copy [this file](https://github.com/dessalines/thumb-key/blob/main/app/src/main/java/com/dessalines/thumbkey/keyboards/ENThumbKey.kt), or another sample keyboard from the same folder.
- The title of the new layout should be lowercase and follow the following format: `[languages] [base] [qualifiers]? [version]?` (see also [#702](https://github.com/dessalines/thumb-key/issues/702)).
- Change the characters to whatever you'd like.
- This file contains both a _shifted_, and _non-shifted_ keyboard, so make sure you take care of both.
- You can also add or subtract columns if you want, but the layout must remain a grid. I **highly recommend** sticking with the 3x3 layout.
Expand Down

0 comments on commit 0d07312

Please sign in to comment.