How to build the keyboard processor

Prerequisites

To build

• Python 3
• Meson build system.
• C++14 or later compiler.

Optional

• kmcomp (for testing)
• wine (for running kmcomp on non-Windows OS)
• hotdoc (for building documentation)

Installing Python3

Linux

You will be able to install a python3 package in any reputable recent version of linux using its package manager if it's not already installed.

Mac OS X

You can get the official installer from the official Python site: https://www.python.org/downloads/mac-osx

Windows

You can get the official installer from the official Python site: https://www.python.org/downloads/windows

Installing Meson

Ensure you have Python3 correctly installed and can run the command pip3.

$> python3 -m pip install meson

Building

In your source directory do the following:

$> cd keyboardprocessor
$> meson build --werror
$> cd build
$> ninja
$> meson test

Note on kmcomp

kmcomp is the command-line compiler from Keyman Developer, available from keyman.com or source in the Keyman repo. The compiler is currently available as a Windows PE executable only, but it does run under WINE.

Windows

The search path can be edited through System settings / Advanced system settings / Environment Variables / User environment variables.

If you have Keyman Developer installed, kmcomp should already be on your path. Otherwise, add the path where you extracted the kmcomp archive.

Linux & MacOS

You will need to ensure that kmcomp.exe is in your PATH and you have wine installed. If the build script detects both present it will automatically prepend wine on all of its invocations of kmcomp.