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 f45f2b97b2 Fixing up a few loose ends in the documentation.
2018-01-11 09:11:35 +07:00
..
samples Minor housekeeping tweaks per code review. 2018-01-09 08:08:49 +07:00
source Fixing up a few loose ends in the documentation. 2018-01-11 09:11:35 +07:00
testing Patches up the /testing pages to work with the new TS layout. 2018-01-08 10:06:32 +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 Initial package.json for NPM dependency management. Handles TypeScript and Google Closure, includes edits to fix new warnings from updated Closure. 2017-12-18 12:22:47 +07:00
history.md web - history.md. 2017-11-24 14:05:07 +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 Initial package.json for NPM dependency management. Handles TypeScript and Google Closure, includes edits to fix new warnings from updated Closure. 2017-12-18 12:22:47 +07:00
package.json Initial package.json for NPM dependency management. Handles TypeScript and Google Closure, includes edits to fix new warnings from updated Closure. 2017-12-18 12:22:47 +07:00
README.md Fixing up a few loose ends in the documentation. 2018-01-11 09:11:35 +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)

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.