X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=test%2FREADME.txt;h=227a35a8e1706acf0951f7a804f812a60132cf60;hp=5ed0c416ea2222b7971d6f8bc22bf89ba59f97cb;hb=8d5dedc247e17f7a460aa3e99991a3421420f256;hpb=189c2d34ac3c77d5aaf90d421db0c1c2b54fff46

diff --git a/test/README.txt b/test/README.txt
index 5ed0c41..227a35a 100644
--- a/test/README.txt
+++ b/test/README.txt
@@ -1,11 +1,79 @@
 Jasmine / jasmine-node test frame works
+=============================================
+
+This directory contains the MasterKey Widget Set (MKWS) Test framework.
+
+
+Installation
 -------------------------------------
+1. install node.js, see http://nodejs.org/
+(and apache2 if you have not already)
+
+# debian7
+$ sudo apt-get install npm
+$ sudo apt-get install apache2
+
+# centos6
+$ sudo yum install npm
+$ sudo yum install httpd
+
+
+The nodejs modules are configured in ./package.json
+You can install them manually with
+$ make node-modules
+
+if you want. The top level makefile in ./mkws/Makefile takes care to
+checkout and update the modules automatically.
+
+
+Testing
+---------------------------------------
+
+
+To run the tests, run:
 
-./spec		contains *spec.js files
-README.txt	this file
+1. basic javscript tests
+
+$ make check
+jasmine-node ./spec
+.......................................
+
+Finished in 2.024 seconds
+39 tests, 194 assertions, 0 failures, 0 skipped
+
+
+2. Testing the Widgets in a headless browser with Jasmine
+
+$ make phantomjs
+[ headless jasmine test with console.log() messages
+
+$ DEBUG=1 make phantomjs PHANTOM_URL=https://example.indexdata.com/jasmine-popup.html
+[ less debug noise ]
+
+
+To get a basic help, run:
+$ make help
+
+
+File system hierarchy
+--------------------------------------
+./spec		contains *spec.js files for phantomjs
+./spec-dev	development *spec.js files
+./js		jasmine runtime JS lib
+./phantom	scripts for phantomjs tests
+./bin		helper scripts
+./etc		configuration files
+./logs		apache access and error log files
+./widgets	screenshots for MKWS widgets
+./images	screenshots for testing
 
 Documentation
--------------------------------------
+---------------------------------------
 http://pivotal.github.io/jasmine/
 https://github.com/pivotal/jasmine
+http://phantomjs.org/
+
 
+--
+Copyright (c) 2013-2014 Index Data ApS. http://indexdata.com
+Oct 2014, Wolfram