erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
spiegel-keyman/developer/js
History
Eddie Antonio Santos 09615db5cc
Create publish script and document.
2019-09-30 13:24:51 -06:00
..
source Remove class-based word breaker. 2019-09-11 10:37:55 -06:00
tests [Developer] Respond to review comments 2019-09-02 14:33:40 +10:00
.gitignore [developer] Initial lexical model compiler files (not yet working) 2019-05-08 10:40:46 +10:00
.npmignore Create publish script and document. 2019-09-30 13:24:51 -06:00
build.sh Create publish script and document. 2019-09-30 13:24:51 -06:00
package-lock.json Start to document how npm packaging will work. 2019-09-30 09:59:55 -06:00
package.json Start to document how npm packaging will work. 2019-09-30 09:59:55 -06:00
README.md Document the cli tools in @keymanapp/lexical-model-compiler 2019-09-30 10:11:37 -06:00
tsconfig.json Add a few more strict checks. 2019-08-19 15:26:28 -06:00

README.md

Keyman Developer

This contains the source code of Keyman development tools:

  • kmlmc — takes lexical model sources and compiles them in to a .js file.
  • kmlmp — uses a .model.kmp file to generate a redistributable lexical model package.
  • kmlmi — merges Keyman lexical model .model_info files.

kmlmc is intended to be used standalone, or as part of a build system. kmlmp is used only by command line tools. kmlmi is used only in the lexical-models repository.

In order to build lexical models, these tools must be built and compiled.

How to build

./build.sh

How to run the tests

./build.sh -test

How to update the package version

NOTE: this step should only be performed on the CI server:

./build.sh -version MAJOR.MINOR.${BUILD_NUMBER} [-tier (alpha|beta)]

How to install

This will install both kmlmc and will let you install the compiler in other node projects on your machine.

./build.sh
npm link

How to use in other Node projects

With the package installed with the above instructions, in your new project, link this package:

npm link @keymanapp/developer-lexical-model-compiler

How to use on the command line

With the package installed with the above instructions, you can now run kmlmc (Keyman Lexical Model Compiler):

kmlmc <your model.ts file> -o <compiled lexical model>