spiegel-keyman/docs/build/linux-ubuntu.md
Marc Durdin 05a4c33200 chore(web): move common/core/web to common/web
Relates to #5816.

Moves folders under common/core/web to common/web:

* input-processor -> common/web/input-processor
* keyboard-processor -> common/web/keyboard-processor
* tools/recorder -> common/web/recorder
* tools/sentry-manager -> common/web/sentry-manager
* utils -> common/web/utils

Updates scripts and configuration to point to new folders.
2022-05-18 06:01:03 +10:00

1.7 KiB

Setup your Keyman build environment on Ubuntu

Target Projects

On Linux, you can build the following projects:

  • Keyman for Android
  • Keyman Core (wasm targets)
  • Common/Web
  • KeymanWeb

The following projects cannot be built on Linux:

  • Keyman for Windows
  • Keyman Developer
  • Keyman for macOS
  • Keyman for iOS

System Requirements

  • Minimum Ubuntu version: Ubuntu 18.04

Other Linux distributions will also work if appropriate dependencies are installed.

Repository Paths

Recommended filesystem layout:

$HOME/keyman/
  keyman/              this repository (https://github.com/keymanapp/keyman)
  keyboards/           https://github.com/keymanapp/keyboards
  sites/
    keyman.com/        https://github.com/keymanapp/keyman.com
    ...

Prerequisites

The current list of dependencies can be found in the Build-Depends section of linux/debian/control. They are most easily installed with the mk-build-deps tool:

sudo apt update
sudo apt install devscripts equivs
sudo mk-build-deps --install linux/debian/control

Keyman for Linux

All dependencies are already installed if you followed the instructions under Prerequisites.

Building:

Keyman Core

All dependencies are already installed if you followed the instructions under Prerequisites.

Building: