yogsototh/leiningen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

A few documentation changes.

Browse source
This commit is contained in:
Phil Hagelberg 2014-09-09 16:25:46 -07:00
parent 9a0448041a
commit 3f373ee918
3 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -1,9 +1,10 @@
# Contributing
Leiningen is the most active open-source Clojure project. We welcome
potential contributors and do our best to try to make it easy to help
out. Contributors who have had a single patch accepted may request
commit rights as well as a free [sticker](http://twitpic.com/2e33r1).
Leiningen is the most widely-contributed-to Clojure project. We
welcome potential contributors and do our best to try to make it easy
to help out. Contributors who have had a single patch accepted may
request commit rights as well as a free
[sticker](http://twitpic.com/2e33r1).
Discussion occurs both in the
[#leiningen channel on Freenode](irc://chat.freenode.net#leiningen)

1
NEWS.md
View file

@ -2,6 +2,7 @@
## 2.4.4 / ???
* Allow certain profiles to be `^:leaky` and affect downstream. (Hugo Duncan)
* Allow profiles to be loaded out of plugins. (Phil Hagelberg, Hugo Duncan)
* Make `leiningen.core.project/read` init the project and merge default profiles. (Phil Hagelberg)
* Move auto-clean to jar task for consistency. (Phil Hagelberg)

12
README.md
View file

@ -57,6 +57,8 @@ project, but here are the commonly-used tasks:
$ lein uberjar # package the project and dependencies as standalone jar
$ lein deploy clojars # publish the project to Clojars as a library
Use `lein help` to see a complete list. `lein help $TASK` shows the
usage for a specific task.
@ -79,7 +81,7 @@ The `project.clj` file in the project root should look like this:
:license "Eclipse Public License 1.0"
:url "http://github.com/technomancy/myproject"
:dependencies [[org.clojure/clojure "1.5.1"]]
:plugins [[lein-ring "0.4.5"]])
:plugins [[lein-tar "3.2.0"]])
```
The `lein new` task generates a project skeleton with an appropriate
@ -95,14 +97,14 @@ The `project.clj` file can be customized further with the use of
Leiningen documentation is organized as a number of guides:
* [Tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
* [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/stable/doc/MIXED_PROJECTS.md)
* [Tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md) (start here if you are new)
* [FAQ](https://github.com/technomancy/leiningen/blob/stable/doc/FAQ.md)
* [Profiles](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
* [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md)
* [Sample project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
* [Writing Plugins](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
* [Writing Templates](https://github.com/technomancy/leiningen/blob/stable/doc/TEMPLATES.md)
* [FAQ](https://github.com/technomancy/leiningen/blob/stable/doc/FAQ.md)
* [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/stable/doc/MIXED_PROJECTS.md)
* [Contributing](https://github.com/technomancy/leiningen/blob/stable/CONTRIBUTING.md)
## Plugins
@ -113,7 +115,7 @@ that modify behaviour of existing tasks. See
for a full list. If a plugin is needed for successful test or build
runs, (such as `lein-tar`) then it should be added to `:plugins` in
project.clj, but if it's for your own convenience (such as
`swank-clojure`) then it should be added to the `:plugins` list in the
`lein-pprint`) then it should be added to the `:plugins` list in the
`:user` profile in `~/.lein/profiles.clj`. See the
[profiles guide](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
for details on how to add to your `:user` profile. The