Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Re-word docs in favour of the term "project automation".

  • Loading branch information...
commit 44994c9d530b7870138d53339c87bc9b58718e22 1 parent 60a8ed8
@technomancy authored
View
25 README.md
@@ -6,13 +6,12 @@
> fiend from hell..."
> -- from Leiningen Versus the Ants by Carl Stephenson
-Leiningen is a build tool for Clojure designed to not set your hair on fire.
+Leiningen is for automating Clojure projects without setting your hair on fire.
<img src="https://github.com/downloads/technomancy/leiningen/leiningen-banner.png" alt="Leiningen logo" title="The man himself" align="right" />
-Building Clojure projects with tools designed for Java can be an
-exercise in frustration. With Leiningen, you describe your build with
-Clojure.
+Working on Clojure projects with tools designed for Java can be an
+exercise in frustration. With Leiningen, you just write Clojure.
## Installation
@@ -24,9 +23,6 @@ upon the first run on unix, so the first run will take longer.
2. Place it on your path and chmod it to be executable.
I like to place it in ~/bin, but it can go anywhere on the $PATH.
-To track development of Leiningen you may use [the master version of the
-script](https://github.com/technomancy/leiningen/raw/master/bin/lein)
-instead. See the "Building" section below.
On Windows most users can
@@ -80,11 +76,11 @@ advantage of this, you should put it on your <tt>$PATH</tt>.
The <tt>project.clj</tt> file in the project root should look like this:
(defproject myproject "0.5.0-SNAPSHOT"
- :description "A build tool designed to not set your hair on fire."
- :url "http://github.com/technomancy/leiningen"
+ :description "A project for doing things."
+ :url "http://github.com/technomancy/myproject"
:dependencies [[org.clojure/clojure "1.2.1"]
[org.clojure/clojure-contrib "1.2.0"]]
- :dev-dependencies [[swank-clojure "1.2.1"]])
+ :dev-dependencies [[lein-ring "0.4.5"]])
The <tt>lein new</tt> task generates a project skeleton with an
appropriate starting point from which you can work. See the
@@ -102,7 +98,7 @@ You can also manage your plugins with the <tt>plugin</tt> task. Use
the same arguments you would put in the Leiningen :dev-dependencies if
you were only using the plugin on a single project.
- $ lein plugin install lein-clojars/lein-clojars "0.6.0"
+ $ lein plugin install lein-clojars "0.6.0"
See the plugin task's help for more information.
@@ -148,7 +144,8 @@ See the plugin task's help for more information.
**Q:** What if my project depends on jars that aren't in any repository?
**A:** The [deploy guide](https://github.com/technomancy/leiningen/blob/stable/DEPLOY.md)
- explains how to set up a private repository.
+ explains how to set up a private repository. If you are not sharing
+ them with a team you could also just [install locally.](http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html).
**Q:** How do I write my own tasks?
**A:** If it's a task that may be useful to more than just your
@@ -163,7 +160,7 @@ See the plugin task's help for more information.
some other project roots into it, Leiningen will allow you to hack
on them in parallel. That means changes in the dependency will be
visible in the main project without having to go through the whole
- install/switch-projects/deps/restart-swank cycle. Note that this is
+ install/switch-projects/deps/restart-repl cycle. Note that this is
not a replacement for listing the project in :dependencies; it
simply supplements that for tighter change cycles.
@@ -201,7 +198,7 @@ See the plugin task's help for more information.
startup time. Leiningen will try to launch a client JVM, but this
only works on 32-bit JVM installations. If you are on a 64-bit
machine you can still use a client JVM if you install 32-bit
- packages; on Ubuntu try ia32-sun-java6-bin. Once you've installed
+ packages; on Debian try ia32-sun-java6-bin. Once you've installed
it, run <tt>sudo update-java-alternatives -s ia32-java-6-sun</tt>.
**Q:** I don't have access to stdin inside my project.
View
2  doc/TUTORIAL.md
@@ -3,7 +3,7 @@
For those of you new to the JVM who have never touched Ant or Maven in
anger: don't panic. Leiningen is designed with you in mind. This
tutorial will help you get started and explain Leiningen's take on
-project building and JVM-land dependency management.
+project automation and JVM-land dependency management.
## Creating a Project
View
10 doc/lein.1
@@ -1,7 +1,7 @@
./"to render: groff -Tascii -man doc/lein.1 > lein.man"
.TH LEININGEN 1 "2011 June 30"
.SH NAME
-lein \- Build Clojure projects
+lein \- Automate Clojure projects
.SH SYNOPSIS
@@ -10,11 +10,11 @@ lein \- Build Clojure projects
.SH DESCRIPTION
-Leiningen is a build tool for Clojure designed to not set your hair on fire.
+Leiningen is for automating Clojure projects without setting your hair
+on fire.
-Building Clojure projects with tools designed for Java can be an
-exercise in frustration. With Leiningen, you describe your build with
-Clojure.
+Working on Clojure projects with tools designed for Java can be an
+exercise in frustration. With Leiningen, you just write Clojure.
.SH TASKS
View
8 pom.xml
@@ -5,7 +5,7 @@
<artifactId>leiningen</artifactId>
<version>1.6.1-SNAPSHOT</version>
<name>leiningen</name>
- <description>A build tool designed not to set your hair on fire.</description>
+ <description>Automate Clojure projects without setting your hair on fire.</description>
<url>https://github.com/technomancy/leiningen</url>
<licenses>
<license>
@@ -15,7 +15,7 @@
<scm>
<connection>scm:git:git://github.com/technomancy/leiningen.git</connection>
<developerConnection>scm:git:ssh://git@github.com/technomancy/leiningen.git</developerConnection>
- <tag>c96c74f5eb5721b621e51f4a70c6ff0211e0d9a0</tag>
+ <tag>81ba0dd02550ee8d89f500c4851289bc90983821</tag>
<url>https://github.com/technomancy/leiningen</url>
</scm>
<build>
@@ -77,7 +77,7 @@
<dependency>
<groupId>robert</groupId>
<artifactId>hooke</artifactId>
- <version>1.1.1</version>
+ <version>1.1.2</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
@@ -93,7 +93,7 @@
</dependencies>
</project>
-<!-- This file was autogenerated by the Leiningen build tool.
+<!-- This file was autogenerated by Leiningen.
Please do not edit it directly; instead edit project.clj and regenerate it.
It should not be considered canonical data. For more information see
https://github.com/technomancy/leiningen -->
View
2  project.clj
@@ -3,7 +3,7 @@
;; loading other task definitions.
(defproject leiningen "1.6.1-SNAPSHOT"
- :description "A build tool designed not to set your hair on fire."
+ :description "Automate Clojure projects without setting your hair on fire."
:url "https://github.com/technomancy/leiningen"
:license {:name "Eclipse Public License"}
:dependencies [[org.clojure/clojure "1.2.1"]
View
2  src/leiningen/pom.clj
@@ -8,7 +8,7 @@
(org.apache.maven.project MavenProject)))
(def #^{:doc "A notice to place at the bottom of generated files."} disclaimer
- "\n<!-- This file was autogenerated by the Leiningen build tool.
+ "\n<!-- This file was autogenerated by Leiningen.
Please do not edit it directly; instead edit project.clj and regenerate it.
It should not be considered canonical data. For more information see
https://github.com/technomancy/leiningen -->\n")
Please sign in to comment.
Something went wrong with that request. Please try again.