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

Updated readme for version 0.6.0

Browse source
This commit is contained in:
zkim 2011-06-27 16:50:26 +00:00
parent f69ebbda12
commit 3341539007
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -13,15 +13,15 @@ Currently Marginalia can be used in a number of ways as described below.
### Command Line
You can download the [Marginalia 0.5.1 jar including packaged dependencies from Github](https://github.com/downloads/fogus/marginalia/marginalia-0.5.1-standalone.jar).
You can download the [Marginalia 0.6.0 jar including packaged dependencies from Github](https://github.com/downloads/fogus/marginalia/marginalia-0.6.0-standalone.jar).
Running Marginalia given the jar file linked above is as easy as:
java -jar marginalia-0.5.1-standalone.jar
java -jar marginalia-0.6.0-standalone.jar
This will search the `PWD` for a `src` directory which it will then traverse looking for Clojure source files to parse and generate documentation for. Marginalia also takes specific locations and files to generate docs for:
java -jar marginalia-0.5.1-standalone.jar <file1> <file2> ... <filen>
java -jar marginalia-0.6.0-standalone.jar <file1> <file2> ... <filen>
Arguments can be specific files or directories.
@ -31,7 +31,7 @@ Arguments can be specific files or directories.
To use Marginalia in your own projects simply add the following to your `project.clj` file in the `:dev-dependencies` section:
[marginalia "0.5.1"]
[marginalia "0.6.0"]
After executing `lein deps` you can generate your complete source documentation with the following command:
@ -46,7 +46,7 @@ section above.
Add marginalia to your project's `:dev-dependencies`:
[marginalia "0.5.1"]
[marginalia "0.6.0"]
Also, you need to add it to your task list: