spiegel-keyman/web/README.md
2017-10-11 16:04:52 +07:00

24 lines
961 B
Markdown

# Keyman Web
The Original Code is (C) 2017 SIL International
## Minimum Web Requirements
Google Closures Compiler is used to compile the JavaScript modules into a single module. Java must be installed to run the compiler, which is stored in the tools folder.
**********************************************************************
The following folders contain the distribution for KeymanWeb:
source Source code
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. The pages using uncompiled KeymanWeb should work as-is.
To view pages using compiled KeymanWeb,
1. cd to **keyman/web/source**
2. Run `/.build.sh`
Refer to the samples for usage details.