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

Very minor README update to add a note about lein2.

Browse source 
It tripped me up for a few minutes (being fairly new to leiningen), so I
thought it might be worth clarifying in the README.
This commit is contained in:
Matt Hoffman 2013-05-22 22:51:52 -04:00
parent 90f3c1eb1f
commit 86f6c0a20d
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -20,11 +20,13 @@ Currently Marginalia can be used in a number of ways as described below.
[http://github.com/fogus/lein-marginalia](http://github.com/fogus/lein-marginalia)
To use Marginalia with Leiningen add the following code to the project's `project.clj` file, in the `:dev-dependencies` argument of the `defproject` function:
To use Marginalia with Leiningen add the following code to the project's `project.clj` file:
:dev-dependencies [[lein-marginalia "0.7.1"]]
With Leiningen 1.x, add `[lein-marginalia "0.7.1"]` to your project.clj's `:dev-dependencies` argument of the `defproject` function, then run `lein deps`.
With Leiningen 2.x, add `[[lein-marginalia "0.7.1"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile.
See the [lein-marginalia](http://github.com/fogus/lein-marginalia) page for more details.
After executing `lein deps` you can generate your complete source documentation with the command:
Once installed, you can generate your complete source documentation with the command:
lein marg <options> <files>