spiegel-keyman/core/docs/api/building.md
Marc Durdin fbab6eb8cf chore(core): move API docs from help.keyman.com
Reorganizes /core/doc to /core/docs and moves internal files
accordingly.

Depends-on: keymanapp/help.keyman.com#1684
2024-11-07 08:28:33 +07:00

1.5 KiB

title
How to build Keyman Core

Prerequisites

To build

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

Optional

  • kmc (for testing)

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.

macOS

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 core
$> ./build.sh configure build test

Note on kmc

kmc is node.js-based the command-line compiler from Keyman Developer, available from keyman.com or on npm at @keymanapp/kmc.

Windows

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

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

Linux & MacOS

Install kmc from the NPM package.