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/README.md
Joshua A. Horton f45f2b97b2 Fixing up a few loose ends in the documentation.
2018-01-11 09:11:35 +07:00

1.1 KiB
Raw Blame History

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)

The following folders contain the distribution for KeymanWeb:

source			Source code
build			Intermediate compiled code; TypeScript source is compiled here before it is minified.
output			Fully-compiled KeymanWeb modules for testing
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.

To view pages using compiled KeymanWeb,

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

Refer to the samples for usage details.