erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
spiegel-keyman/web
History
Joshua A. Horton e2e5a64e04 Documentation update.
2018-01-30 11:15:32 +07:00
..
samples Re-did the build product directory structure again. 2018-01-22 14:07:16 +07:00
source Documentation update. 2018-01-30 11:15:32 +07:00
testing Re-did the build product directory structure again. 2018-01-22 14:07:16 +07:00
.editorconfig Update resetContext 2017-09-07 15:06:11 +07:00
.gitattributes Patches up the /samples pages. 2018-01-08 09:51:19 +07:00
.gitignore Re-did the build product directory structure again. 2018-01-22 14:07:16 +07:00
history.md Further refactoring + some bookkeeping after recent related PR merges/edits. 2018-01-23 09:50:35 +07:00
index.html Refactored the samples section to create a separate testing section. 2017-10-11 15:31:06 +07:00
LICENSE Move KeymanWeb project to web/ 2017-05-26 11:00:34 +07:00
NOTICE Move KeymanWeb project to web/ 2017-05-26 11:00:34 +07:00
package-lock.json Significant work performed for potential minification. 2017-12-19 18:07:27 +07:00
package.json Significant work performed for potential minification. 2017-12-19 18:07:27 +07:00
README.md Documentation update. 2018-01-30 11:15:32 +07:00

README.md

Keyman Web

The Original Code is (C) 2017 SIL International

Minimum Web Compilation Requirements

  • A local installation of Node.js.
    • Builds will call npm install to automatically install further necessary build dependencies.
  • Java 7+ (required by the Google Closure Compiler for minification builds)

The following folders contain the distribution for KeymanWeb:

source				         Source code
intermediate    	         Intermediate compiled code; TypeScript source is compiled here before it is minified.
release/web	                 Fully-compiled KeymanWeb modules
release/embedded	         Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds
release/unminified/web       Fully-compiled but non-minified KeymanWeb modules
release/unminified/embedded  Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds
samples				         Sample pages demonstrating ways to link with KeymanWeb
testing     		         Test-case web-pages for various aspects of KeymanWeb functionality

Usage

Open index.html or samples/index.html in your browser. Be sure to compile KeymanWeb before viewing the pages.

Refer to the samples for usage details.

To view pages using compiled KeymanWeb,

  1. cd to keyman/web/source
  2. Run /.build.sh

build.sh options:

  • -ui
    • to compile desktop user interface modules to output folder
  • -test
    • to compile for testing without copying resources or updating the saved version number.
  • -embed
    • to compile only the KMEA/KMEI embedded engine.
  • -web
    • to compile only the KeymanWeb engine.
  • -debug_embedded
    • to compile a readable version of the embedded KMEA/KMEI code
  • -no_minify
    • to disable the minified '/release/web' and '/release/embedded' build sections.
    • the '/release/unminified/web' and '/release/unminified/embedded' folders will still be built.
  • -clean
    • to erase pre-existing build products before the build.

If more than one target is specified, the last one will take precedence.