From c3aa9aa70c608c3e72b05777948eb27ae2a08096 Mon Sep 17 00:00:00 2001 From: Gabriel Wong Date: Thu, 31 Aug 2017 15:38:01 +0700 Subject: [PATCH] Update web README --- web/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/web/README.md b/web/README.md index 81defbd51c..04a9c6fd86 100644 --- a/web/README.md +++ b/web/README.md @@ -1,8 +1,8 @@ -# Keyman Web # +# 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. +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. ********************************************************************** @@ -13,6 +13,11 @@ The following folders contain the distribution for KeymanWeb 2.0: embedded Fully-compiled KMEA/KMEI modules for inclusion in mobile app builds samples Sample and test-case web-pages +## 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.