erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-09-14 11:37:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/common/core/desktop/doc/BUILDING.md
Marc Durdin 4af39a58b0 docs: start consolidation of build config docs 
As the build environment documentation is duplicated across each of the
Keyman platform projects, it has become somewhat convoluted and
inconsistent. This PR moves all the mac-based and shared documentation
into docs/build, with placeholders for Windows and Linux documentation
to be moved in the next PR.

The idea is that a developer can configure their box to build any of the
available projects for that platform (web and android build on all three
main dev platforms).

Keeping the build documentation in one place makes it much simpler to
keep it consistent and up-to-date as well, as well as keeping us aware
of potential dependency conflicts between projects.

The icing on the cake is the resources/devbox/macos/macos.sh script,
which I have tested and takes a bare metal mac box through to a full
Keyman development environment (except XCode, there's always something!)
2021-06-21 21:12:27 +10:00

546 B
Raw Blame History

How to build the keyboard processor

Prerequisites

See build configuration for details on how to configure your build environment.

Building

On all platforms, use build.sh.

  • See ./build.sh --help for more details

Note on kmcomp

kmcomp is the command-line compiler from Keyman Developer, available from https://keyman.com/developer/download or in this repo in /windows/src/developer/kmcomp. The compiler is currently available as a Windows PE executable only, but it does run under WINE.