[General] format to fit 80char terminal devel
authorXu Zhang <xu.u.zhang@intel.com>
Thu, 17 Oct 2013 11:00:28 +0000 (19:00 +0800)
committerXu Zhang <xu.u.zhang@intel.com>
Thu, 17 Oct 2013 11:00:28 +0000 (19:00 +0800)
* Thanks for Bob Spencer's founding. made changes according to
  patch provided by Bob.

Signed-off-by: Xu Zhang <xu.u.zhang@intel.com>
README.md
bin/tizen-web-app-checker.js

index 352a8f4..27e50c2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,37 +1,33 @@
 ## Tizen Web Application Checker ##
 
-    Tizen Web Application Checker is a tool you can use to check whether web applications
-    are Tizen compliant, based on rules in Tizen Compliance Specification. The checker
-    verifies the given web application's package validity, API usage, and adherence to
-    security rules. For your reference, a report will be generated to clearly list potential
-    incompatibility issues.
+  The Tizen Web Application Checker is a tool you can use to check whether web
+  applications will run on Tizen compliant devices based on rules in the Tizen
+  Compliance Specification. The checker verifies a web application's package
+  validity, API usage, and adherence to security rules. It then creates a
+  user-friendly, HTML report of potential incompatibility issues. It can also
+  output JSON or XML formatted reports for use in test automation.
 
-    Tizen Web Application Checker provides guidance to Tizen web application developers.
-    Also, release engineers and QA can automate the testing process by integrating the
-    checker into their test application.
-
-    The checker can run on Ubuntu 11.04 and later(32 or 64 bit), windows 7 and Mac.
+  The checker can run on Ubuntu 11.04 and later(32 or 64 bit), windows 7 and
+  Mac.
 
 ### Dependencies ###
-The tool is based on Node.js(v0.8 or above).
-So, please check your environment before using it.
+The tool requires Node.js v0.8 or newer.
 To check your version of Node.js, run this code from the command line:
 
     node --version
 
 ### Usage ###
-To check a given web application, run this code from the command line:
+To check a web application, run this code from the command line:
 
-    node $<tizen-web-app-checker>/bin/tizen-web-app-checker.js [options] <Tizen web application (.wgt) file>
+    node ./bin/tizen-web-app-checker.js [options] <web application (.wgt file)>
 
-Default *<name>.html* and *<name>.log* file will be generated in current directory.
-You can see the details by accessing their content.
+Results of the checker are output as <web app name>.html and <web
+app name>.log in the current directory.
 
 More helpful usage can be found by running:
 
-    node $<tizen-web-app-checker>/bin/tizen-web-app-checker.js -h
+    node ./bin/tizen-web-app-checker.js -h
 
-For example, check a Tizen sample application Annex.wgt, including API checking:
+For example, to check the web application Annex.wgt, including API checking:
 
-    cd $<tizen-web-app-checker>
     node ./bin/tizen-web-app-checker.js -a ./web/test/tizenSDKSamples/Annex.wgt
index b6d2356..aca5661 100755 (executable)
         .option("-s, --spec <" + TizenSpec.join(",") + ">", "Specify Tizen API version used to check. Tizen " + TizenSpec[TizenSpec.length - 1] + " is used by default")
         .option("-a, --apiCheck", "Enable API check. API check is an experiment feature")
         .option("-p, --privLevel <public|partner|platform>", "Specify privilege level for distributing. Public is used by default")
-    commander.usage('[Options] <Tizen web application (.wgt) file>')
+    commander.usage('[Options] <web application (.wgt) file>')
              .description("tizen web application checker:  A compatibility checker for Tizen web applications.");
 
     /* ====== Exports ====== */