Skip to content

Commit 88e40f3

Browse files
committed
Changed README to conform to standard
1 parent 4100e99 commit 88e40f3

1 file changed

Lines changed: 65 additions & 13 deletions

File tree

README.md

Lines changed: 65 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,79 @@
1-
# test.generative
1+
clojure.test.generative
2+
========================================
23

34
Test data generation and execution harness. Very early days.
45
This API will change. You have been warned.
56

6-
## Usage
77

8-
See the namespace comment for clojure.test.generative.
98

10-
## Installation
9+
Releases and Dependency Information
10+
========================================
1111

12-
test.generative is not yet available in Maven Central. To build
12+
Latest stable release: 0.1.4
1313

14-
mvn package
14+
* [All Released Versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22test.generative%22)
1515

16-
## Running Examples
16+
* [Development Snapshot Versions](https://oss.sonatype.org/index.html#nexus-search;gav~org.clojure~test.generative~~~)
1717

18-
mvn dependency:build-classpath -Dmdep.outputFile=script/maven-classpath
19-
script/examples
18+
[Leiningen](https://github.com/technomancy/leiningen) dependency information:
2019

21-
Note the examples will fail until http://dev.clojure.org/jira/browse/CLJ-426 is fixed!
20+
[org.clojure/test.generative "0.1.4"]
2221

23-
## License
22+
[Maven](http://maven.apache.org/) dependency information:
2423

25-
Copyright Rich Hickey, Stuart Halloway, and contributors.
24+
<dependency>
25+
<groupId>org.clojure</groupId>
26+
<artifactId>test.generative</artifactId>
27+
<version>0.1.4</version>
28+
</dependency>
2629

27-
Licensed under the EPL. (See the file epl.html.)
30+
31+
32+
Example Usages
33+
========================================
34+
35+
A defspec consists of a name, a function to be tested, an input spec,
36+
and a validator:
37+
38+
(defspec integers-closed-over-addition
39+
(fn [a b] (+' a b)) ;; input fn
40+
[^long a ^long b] ;; input spec
41+
(assert (integer? %))) ;; 0 or more validator forms
42+
43+
Given a var, namespace, or directory, you can run the tests for it:
44+
45+
(test-vars #'integers-closed-over-addition)
46+
(test-namespaces 'clojure.test.generative-test)
47+
(test-dirs \"src/test/clojure\")
48+
49+
Succesful test output includes :iterations, :msec, and the :var for
50+
each test run:
51+
52+
{:iterations 44645, :msec 1429,
53+
:var #'clojure.test.generative-test/numbers-closed-over-addition}
54+
55+
56+
Developer Information
57+
========================================
58+
59+
* [GitHub project](https://github.com/clojure/test.generative)
60+
61+
* [Bug Tracker](http://dev.clojure.org/jira/browse/TGEN)
62+
63+
* [Continuous Integration](http://build.clojure.org/job/test.generative/)
64+
65+
* [Compatibility Test Matrix](http://build.clojure.org/job/test.generative-test-matrix/)
66+
67+
68+
69+
Change Log
70+
====================
71+
72+
* Release 0.1.4 on 2012.01.03
73+
* Initial version
74+
75+
76+
Copyright and License
77+
========================================
78+
79+
Copyright (c) 2012 Rich Hickey. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.

0 commit comments

Comments
 (0)