Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Changed README to conform to standard

  • Loading branch information...
commit 88e40f300668331808f374c687d3d52a61c68040 1 parent 4100e99
@fogus fogus authored
Showing with 65 additions and 13 deletions.
  1. +65 −13 README.md
View
78 README.md
@@ -1,27 +1,79 @@
-# test.generative
+clojure.test.generative
+========================================
Test data generation and execution harness. Very early days.
This API will change. You have been warned.
-## Usage
-See the namespace comment for clojure.test.generative.
-## Installation
+Releases and Dependency Information
+========================================
-test.generative is not yet available in Maven Central. To build
+Latest stable release: 0.1.4
- mvn package
+* [All Released Versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22test.generative%22)
-## Running Examples
+* [Development Snapshot Versions](https://oss.sonatype.org/index.html#nexus-search;gav~org.clojure~test.generative~~~)
- mvn dependency:build-classpath -Dmdep.outputFile=script/maven-classpath
- script/examples
+[Leiningen](https://github.com/technomancy/leiningen) dependency information:
-Note the examples will fail until http://dev.clojure.org/jira/browse/CLJ-426 is fixed!
+ [org.clojure/test.generative "0.1.4"]
-## License
+[Maven](http://maven.apache.org/) dependency information:
-Copyright Rich Hickey, Stuart Halloway, and contributors.
+ <dependency>
+ <groupId>org.clojure</groupId>
+ <artifactId>test.generative</artifactId>
+ <version>0.1.4</version>
+ </dependency>
-Licensed under the EPL. (See the file epl.html.)
+
+
+Example Usages
+========================================
+
+A defspec consists of a name, a function to be tested, an input spec,
+and a validator:
+
+ (defspec integers-closed-over-addition
+ (fn [a b] (+' a b)) ;; input fn
+ [^long a ^long b] ;; input spec
+ (assert (integer? %))) ;; 0 or more validator forms
+
+Given a var, namespace, or directory, you can run the tests for it:
+
+ (test-vars #'integers-closed-over-addition)
+ (test-namespaces 'clojure.test.generative-test)
+ (test-dirs \"src/test/clojure\")
+
+Succesful test output includes :iterations, :msec, and the :var for
+each test run:
+
+ {:iterations 44645, :msec 1429,
+ :var #'clojure.test.generative-test/numbers-closed-over-addition}
+
+
+Developer Information
+========================================
+
+* [GitHub project](https://github.com/clojure/test.generative)
+
+* [Bug Tracker](http://dev.clojure.org/jira/browse/TGEN)
+
+* [Continuous Integration](http://build.clojure.org/job/test.generative/)
+
+* [Compatibility Test Matrix](http://build.clojure.org/job/test.generative-test-matrix/)
+
+
+
+Change Log
+====================
+
+* Release 0.1.4 on 2012.01.03
+ * Initial version
+
+
+Copyright and License
+========================================
+
+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.
Please sign in to comment.
Something went wrong with that request. Please try again.