Skip to content

Commit

Permalink
Improve the README a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
bbatsov committed Dec 14, 2015
1 parent 9ed91e2 commit 6ccf531
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,34 +171,42 @@ avoid classpath collisions.

To work with `mranderson` the first thing to do is:

`lein do clean, source-deps`
```
lein do clean, source-deps
```

This creates the munged local dependencies in `target/srcdeps` directory.

After that you can run your tests or your REPL with:

`lein with-profile +plugin.mranderson/config repl`

`lein with-profile +plugin.mranderson/config test`
```
lein with-profile +plugin.mranderson/config repl
lein with-profile +plugin.mranderson/config test
```

Note the plus sign before the leiningen profile. For this leiningen
Note the `+` sign before the leiningen profile. For this leiningen
profile to work **you need leiningen version 2.5.0+!** If you want to
use `mranderson` while developing locally with the REPL the source has
to be modified in the `target/srcdeps` directory. When you want to
release locally:

`lein with-profile plugin.mranderson/config install`
```
lein with-profile plugin.mranderson/config install
```

Release to clojars:

`lein with-profile plugin.mranderson/config deploy clojars`
```
lein with-profile plugin.mranderson/config deploy clojars
```

Or you can use the very sophisticated script to clean, inline, test
and run an end target like install or deploy:

`./build.sh install`

`./build.sh deploy clojars`
```
./build.sh install
./build.sh deploy clojars
```

[build.sh](build.sh) cleans, runs source-deps with the right
parameters, runs the tests and then runs the provided lein target.
Expand Down

0 comments on commit 6ccf531

Please sign in to comment.