-
-
Notifications
You must be signed in to change notification settings - Fork 112
Home
rc-swag edited this page Sep 20, 2023
·
33 revisions
Welcome to the keyman wiki! This wiki contains information for programmers and testers working on the Keyman project. For Keyman documentation, see https://help.keyman.com/
Some shortcuts to pages in this wiki:
- api.keyman.com keyboard model package version API
- downloads.keyman.com history API
- downloads.keyman.com keyboard API
- downloads.keyman.com model API
- downloads.keyman.com version API
- Keyboard Processor API (KPAPI) temp reference
- history.md format
- KMP Metadata File (kmp.inf and kmp.json)
- Permalinks for keyboards
- Keyman State Machine
- How to test artifacts from pull requests for Keyman for Linux
- How to downgrade to latest stable version of Keyman for Linux
- How to uninstall Keyman for macOS for testing
- Keyman Code Style Guide
- Keyman Project Scopes
- Principles of Keyman Code Changes
- Pull Request and Commit workflow notes
- User Testing
Documentation should be found in the following four locations:
- Keyman repository /docs: preferred location for good quality notes; should be kept reasonably up-to-date (in Markdown).
- This Keyman wiki: rough notes (in Markdown)
- Help website: public-facing documentation, API documentation, etc. (Some in HTML, moving to Markdown)
- Google Drive: architecture, planning, and design docs, Google Docs and various formats. Generally these should move to Keyman Repository /docs as we implement.
- How to set up a local web server for the Keyman web pages
- How to setup conventional commits git commit msg hook
- Linux Build Agent Setup
- macOS Build Agent Setup
- Windows Build Agent Setup
- Crowdin CLI
- Making sense of the Windows Layout Registration
- kmtip and keyman32 interactions
- Delphi Debugging kmshell
- Test Installed desktop Keyboards with Keyman Developer Test Page -including TSF
- Keyman for Windows architecture FAQs
- Keyman keyboard with"application" mangles output(cluster deletion)