Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add info to readme

  • Loading branch information...
commit 2161026c9cd8076b1a416338bf2bf102ea612b99 1 parent ba28a71
@maravillas authored
Showing with 33 additions and 5 deletions.
  1. +33 −5 README
View
38 README
@@ -1,17 +1,45 @@
# lein-multi
-FIXME: write description
+lein-multi is a Leiningen plugin for running tasks against multiple dependency sets. Most notably, it allows you to test your project against multiple versions of Clojure.
## Usage
-FIXME: write
+Syntax:
+
+`$ lein multi <task> [args]`
+
+Specify dependency sets in your project.clj:
+
+ :multi-deps [[[org.clojure/clojure "1.1.0"]
+ [ring-core "0.2.2"]]
+ [[org.clojure/clojure "1.2.0-beta1"]
+ [ring-core "0.3.0-SNAPSHOT"]]]
+
+Download these dependencies with `lein multi deps` (or by running your tests with `lein multi test`). They will be placed in the folder specified by `:multi-library-path` (default: `multi-lib`).
+
+lein-multi will accept and run other tasks, though the result may not be what you expect. Tasks that do not require a project (currently `new`, `help`, and `version`) are run as normal.
+
+Additionally, other tasks may require special handling that isn't yet implemented. For example, `lein multi uberjar` will only create one jar.
## Installation
-FIXME: write
+Add the following to your project.clj :dev-dependencies:
+
+`[lein-multi "0.1.0-SNAPSHOT"]`
+
+Download the plugin with `lein deps`.
+
+## TODO
+
+* Special handling for pom, jar, uberjar, and clean
+* Final test summary for all sets
## License
-Copyright (C) 2010 FIXME
+Copyright (c) 2010 Matthew Maravillas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-Distributed under the Eclipse Public License, the same as Clojure.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please sign in to comment.
Something went wrong with that request. Please try again.