From 86f6c0a20d809a58a840997b6913028574854a57 Mon Sep 17 00:00:00 2001 From: Matt Hoffman Date: Wed, 22 May 2013 22:51:52 -0400 Subject: [PATCH] Very minor README update to add a note about lein2. It tripped me up for a few minutes (being fairly new to leiningen), so I thought it might be worth clarifying in the README. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e378f6b..3dde4f1 100644 --- a/README.md +++ b/README.md @@ -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