give the test dir a specific readme file

2012-09-24 22:29:49 +02:00
parent 1f457fc919
commit fbaefeea7c
1 changed files with 23 additions and 0 deletions
--- a/test/readme.md
+++ b/test/readme.md
@@ -0,0 +1,23 @@
+Included in this directory
+--------------------------
+
+- ol.html - the web page used to run the test suite.
+
+- spec - includes the OpenLayers test/spec files.
+
+- jasmine-1.2.0 - includes the Jasmine Testing Framework.
+  https://github.com/pivotal/jasmine
+
+- jasmine-extensions.js - includes OpenLayers-specific extensions to Jasmine.
+
+- phantom-jasmine - a PhantomJS script and a console reporter to for headless
+  testing. Comes from https://github.com/jcarver989/phantom-jasmine.
+
+Run the test suite with PhantomJS
+---------------------------------
+
+With PhantomJS installed, and assuming phantomjs is in the PATH:
+
+    $ phantomjs phantom-jasmine/run_jasmine_test.coffee ol.html
+
+(Works with PhantomJS 1.6.1, untested with other versions.)