/README

 1
 2JS Quickcheck Features
 3======================
 4
 5- Listener UI's for Firebug, Firebug Lite (cross browser), and Rhino 
 6- Arbitrary generators are objects with fields arb and shrink (to add
 7  shrinking support later. The field shrink is optional and interpreted as 'null' if not present).
 8- Nice stable of generators available out of the box.
 9- arbArray to generate an arbitrary JS array.
10- arbSelect to uniformly select one of the given generators
11- arbNull which will always return 'null'
12- arbNullOr generator returning null or the given generators return
13  value (probability for null is 0.1)
14- implemented 'classify' and 'collect' (see selfcheck.js for example)
15- implemented simple shrinking strategies for primitive types
16- arbArray has an optional second parameter setting its shrinking strategy 
17- runrhino.js to tests so one can run selfcheck from command line by
18  'rhino runrhino.js'
19- implemented expectException property modifier
20
21TODO:
22=====
23- start some kind of documentation
24
25Build Documentation:
26====================
27
28In order to build the documentation you will need:
29
30- jsdoc toolkit (http://code.google.com/p/jsdoc-toolkit/). 
31  It is recommended to set the JSDOCDIR environment variable
32
33- jsdoc simple template (http://github.com/urso/jsdoc-simple):
34  just copy 'jsdoc-simple' directory to jsdoc toolkit's template directory
35
36- run './mkdoc' shell command (needs *nix shell).
37
38
39qc.js was originally written by Darrin Thompson with extensive contributions
40from Steffen Siering.