spiegel-keyman/developer/docs/help/guides/intro.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.9 KiB

title
Introducing Keyman Developer

Welcome to Keyman Developer

Keyman Developer allows you to create your own keyboard layouts for use on the Keyman platform. Keyman is a multi-platform input method solution that runs on Windows, macOS, the web, mobile web, iOS and Android and Linux.

There are two core applications included in Keyman Developer: the Keyman Developer IDE (formerly called TIKE), and the command line compiler kmc.

Watch a video that highlights some of the Keyman Developer features.

Keyman Developer IDE

The Keyman Developer IDE is a complete environment for designing, developing, testing, and packaging your keyboards for distribution. Some of the major features of Keyman Developer IDE are:

  • Keyboard Editor, for creating keyboards visually for all platforms
  • Touch Layout editor, for creating fluid touch layouts
  • Package Editor, for creating a package of keyboard, fonts and files for distribution (used on all platforms except web)
  • Lexical Model Editor, for creating predictive text models
  • Integrated compiler, to compile keyboards, packages and models
  • Fully interactive debugger for testing keyboards and models
  • Character Map, which supports viewing Unicode fonts under all Windows versions
  • On Screen Keyboard editor, for creating visual representations of keyboards
  • Projects, for managing keyboard and lexical model development projects large and small

Source files (except images!) are normally written in UTF-8 format, so they can be opened with any text editor. However, the Keyman Developer IDE provides much tooling to simplify editing each of the types of files. The Keyman Developer IDE runs on Windows.

kmc, the command line compiler

kmc, the command-line compiler, is a comprehensive tool that lets you compile keyboards, packages, models and projects from the command-line.