Working with the Keyman Cloud Keyboard Repository
The Keyman Cloud repository is the master source for all keyboard layouts distributed within the Keyman app. These keyboards have been contributed by many authors since the mid 1990's.
The Keyman Keyboard Repository
We now have a single location for open source keyboards on github.com
From these source files, we build the keyboards that can be downloaded from https://keyman.com.
A large proportion of the keyboards on the site, including nearly all the keyboards that we have developed, are open source keyboards. This means that you can download the layouts yourself and improve them, and we hope you will contribute your own keyboards to this repository for all to use.
Why You Should Contribute
- Version Control:
- Automatic Keyboard Updates
Many previous keyboards were stored on websites that no longer exist. Configuring your keyboard in the keyboards repository helps ensure that users can download your keyboard from keyman.com and find the documentation on help.keyman.com. The source files for your keyboard will remain in the GitHub repository mentioned above so you'll be able to find the keyboard source for future updates.
Configuring your keyboard source in GitHub helps keyboard maintainers track the history of changes in your keyboard. Keyboard maintainers will also be able to see when keyboards are deprecated by another keyboard.
The catalog of Keyman keyboards is automatically rebuilt when updates to the keyboard repo are made, and your keyboard users will receive notifications in their Keyman apps when newer keyboard versions become available.
How the Repository is Organized
The "release" section of the repository (contained in the "release" folder) contains keyboards that have complete source files and documentation.
The "experimental" section of the repository (in the "experimental" folder) contains keyboards that are under active development, but don't yet have all the files necessary for release, or are being tested by user community members before finalizing the design.
The "legacy" section of the repository (in the "legacy" folder) contains older keyboards that are functional, but don't contain complete source and documentation.
Within each section of the repository, there is a level of subfolders that serve to group the keyboards so that it isn't necessary to scroll through hundreds of entries to find a particular keyboard. Most of these subfolders are single alphabetic characters, and each folder contains the keyboards that start with that letter. In addition, there are some folders (fv and gff, for example) that correspond to organizations which have contributed a number of keyboards.