un-HTMLify autotests README
authorDan Vanderkam <dan@dygraphs.com>
Mon, 6 Jun 2011 13:28:08 +0000 (09:28 -0400)
committerDan Vanderkam <dan@dygraphs.com>
Mon, 6 Jun 2011 13:28:08 +0000 (09:28 -0400)
auto_tests/README [new file with mode: 0644]
auto_tests/README.html [deleted file]

diff --git a/auto_tests/README b/auto_tests/README
new file mode 100644 (file)
index 0000000..caf0bea
--- /dev/null
@@ -0,0 +1,46 @@
+These tests are run with js-test-driver
+(http://code.google.com/p/js-test-driver/).
+
+Running tests
+-------------
+
+- Start a terminal window at the dygraphs root directory (one
+  directory up from here.)
+
+- From there, you start the test server and capture at least one slave
+  browser:
+
+   Run:
+   $ java -jar ./auto_tests/lib/JsTestDriver-1.3.2.jar --port 9876
+  
+   Open
+   http://localhost:9876/capture
+   in the browser you want to use for your test.
+
+- Run the tests with:
+
+  $ java -jar ./auto_tests/lib/JsTestDriver-1.3.2.jar --tests all
+
+
+Debugging tests
+---------------
+
+This is a bit of a hack, but you can also run tests manually inside the browser
+using auto_tests/misc/local.html.
+
+Once you've opened that page, open up the JavaScript console and run something
+like:
+
+  new SimpleDrawingTestCase().runTest("testDrawSimpleRangePlusOne")
+
+to run just one test. This is useful for seeing the dygraph that the test
+creates, setting breakpoints, etc.
+
+Please don't rely on it as proof that your tests pass; the command-line is the
+reference for ensuring Dygraphs automated tests pass.
+
+
+(This is a specialized version of the instructions found at 
+http://code.google.com/p/js-test-driver/wiki/GettingStarted.
+They're listed as a courtesy, but you really should get to understand
+js-test-driver, which has lots of powerful features.)
diff --git a/auto_tests/README.html b/auto_tests/README.html
deleted file mode 100644 (file)
index d5826b9..0000000
+++ /dev/null
@@ -1,36 +0,0 @@
-<html>
-<head>
-</head>
-<body>
-These tests are run with <a href="http://code.google.com/p/js-test-driver/">
-js-test-driver</a>. To use:
-
-This is a specialized version of the instructions found at the js-test-driver
-<a href="http://code.google.com/p/js-test-driver/wiki/GettingStarted">
-Getting Started</a> wiki. They're listed as a courtesy, but you really should
-get to understand js-test-driver, which has lots of powerful features.
-
-To run tests:
-<ul>
-  <li>Start a terminal window at the dygraphs root directory (one
-    directory up from here.)</li>
-  <li>From there, you start the test server and capture at least one slave
-    browser.
-    <ol>
-      <li>Run <code>java -jar ./auto_tests/lib/JsTestDriver-1.3.2.jar --port
-        9876</code></li>
-      <li>Open <a href="http://localhost:9876/capture">
-        http://localhost:9876/capture</a> in the browser you want to use for
-      your test.</li>
-    </ol>
-  </li>
-  <li>Run the tests with <code>java -jar ./auto_tests/lib/JsTestDriver-1.3.2.jar
-      --tests all</code></li>
-</ul>
-
-This is a bit of a hack, but you can also run tests locally, and manually, by
-using this <a href="./misc/local.html">testing page</a>. Please don't rely on it
-as proof that your tests pass; the command-line is the reference for ensuring
-Dygraphs automated tests pass.
-</body>
-</html>