Browse files

updating Welcome message

  • Loading branch information...
1 parent d4aa930 commit 4549309e6917e5f9094f7b822d5c3b8d0c035002 @anutron committed May 2, 2011
Showing with 13 additions and 2 deletions.
  1. +13 −2 WELCOME.md
View
15 WELCOME.md
@@ -3,7 +3,18 @@ Welcome to the MooTools Test/Demo Runner
This environment allows developers to write interactive tests and demos. To install, see the [README on github](http://github.com/anutron/mootools-test-runner#readme).
-Browsing the Tests / Demos
+Browsing the Demos and Docs
----------
-The test environment should find all available tests and list them in a menu on the left of the screen. Clicking any test should load it with all the required JavaScript. Once loaded, the interactive test should be available for you to manipulate. Some tests are somewhat passive - you just watch them do something - but most allow you to click things. Each test should have instructions on what to do.
+To view the documentation, click "Docs" at the top of the screen and then select a document to view in the menu on the left. You can use the search box to quickly find your selection.
+
+To view demos, do the same except click "Demos" at the top of the screen. Clicking any test should load it with all the required JavaScript. Once loaded, the interactive test should be available for you to manipulate. Some tests are somewhat passive - you just watch them do something - but most allow you to click things. Each test should have instructions on what to do.
+
+Running Specs and Benchmarks
+-----------
+
+Select "Specs" in the menu above and choose which groups of specs you want to run. The [Jasmine](https://github.com/pivotal/jasmine) testing framework will run through all the chosen specs. You can click on any spec in the results to run it again.
+
+Benchmarks use [Benchmark.js](http://benchmarkjs.com) to run any registered and configured benchmarks. Once loaded, you can run all or a subset of benchmarks. Be sure to check out the graph at the bottom for your results.
+
+Note that you can hold down shift and click to select ranges for the benchmarks or specs.

0 comments on commit 4549309

Please sign in to comment.