switch over to using Testacular for E2E tests

[angular-drzb] / README.md

diff --git a/README.md b/README.md
index 46445ed..b3b50ab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
-# angular-seed — the seed for <angular/> apps
+# angular-seed — the seed for AngularJS apps
 
-This project is an application skeleton for a typical [angular](http://angularjs.org/) web app. You
-can use it to quickly bootstrap your angular webapp projects and dev environment for these projects.
+This project is an application skeleton for a typical [AngularJS](http://angularjs.org/) web app.
+You can use it to quickly bootstrap your angular webapp projects and dev environment for these
+projects.
 
 The seed contains angular libraries, test libraries and a bunch of scripts all preconfigured for
 instant web development gratification. Just clone the repo (or download the zip/tarball), start up
@@ -57,10 +58,10 @@ to use whatever works for you.
 
 Requires java and a local or remote browser.
 
-* start `scripts/test-server.sh`
+* start `scripts/test-server.sh` (on windows: `scripts\test-server.bat`)
 * navigate your browser to `http://localhost:9876/`
 * click on one of the capture links (preferably the "strict" one)
-* run `scripts/test.sh`
+* run `scripts/test.sh` (on windows: `scripts\test.bat`)
 
 
 ### Continuous unit testing
@@ -68,7 +69,7 @@ Requires java and a local or remote browser.
 Requires ruby and [watchr](https://github.com/mynyml/watchr) gem.
 
 * start JSTD server and capture a browser as described above
-* start watchr as `watchr scripts/watchr.rb`
+* start watchr with `watchr scripts/watchr.rb`
 * in a different window/tab/editor `tail -f logs/jstd.log`
 * edit files in `app/` or `src/` and save them
 * watch the log to see updates
@@ -84,9 +85,16 @@ you to write your tests with jasmine-like BDD syntax.
 
 Requires a webserver, node.js or your backend server that hosts the angular static files.
 
+Check out the
+[end-to-end runner's documentation](http://docs.angularjs.org/guide/dev_guide.e2e-testing) for more
+info.
+
 * create your end-to-end tests in `test/e2e/scenarios.js`
 * serve your project directory with your http/backend server or node.js + `scripts/web-server.js`
-* open `http://localhost:port/test/e2e/runner.html` in your browser
+* to run do one of:
+  * open `http://localhost:port/test/e2e/runner.html` in your browser
+  * run the tests from console with [Testacular](vojtajina.github.com/testacular) via
+    `scripts/e2e-test.sh` or `script/e2e-test.bat`
 
 
 ### Receiving updates from upstream
@@ -101,6 +109,7 @@ fetch the changes and merge them into your project with git.
       css/              --> css files
         app.css         --> default stylesheet
       img/              --> image files
+      index.html        --> app layout file (the main html template file of the app)
       js/               --> javascript files
         controllers.js  --> application controllers
         filters.js      --> custom angular filters
@@ -110,19 +119,23 @@ fetch the changes and merge them into your project with git.
         angular/
           angular.js            --> the latest angular js
           angular.min.js        --> the latest minified angular js
-          angular-ie-compat.js  --> angular patch for IE 6&7 compatibility
+          angular-*.js  --> angular add-on modules
           version.txt           --> version number
       partials/         --> angular view partials (partial html templates)
         partial1.html
         partial2.html
 
-    jsTestDriver.conf   --> config file for JsTestDriver
+    config/jsTestDriver.conf    --> config file for JsTestDriver
 
     logs/               --> JSTD and other logs go here (git-ignored)
 
     scripts/            --> handy shell/js/ruby scripts
-      test-server.sh    --> starts JSTD server
-      test.sh           --> runs all unit tests
+      e2e-test.sh       --> runs end-to-end tests with Testacular (*nix)
+      e2e-test.bat      --> runs end-to-end tests with Testacular (windows)
+      test-server.bat   --> starts JSTD server (windows)
+      test-server.sh    --> starts JSTD server (*nix)
+      test.bat          --> runs all unit tests (windows)
+      test.sh           --> runs all unit tests (*nix)
       watchr.rb         --> config script for continuous testing with watchr
       web-server.js     --> simple development webserver based on node.js