Skip to content

Commit cebd185

Browse files
committed
Document the clojars JAR
1 parent 1ae2110 commit cebd185

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
Code Maat is a command line tool used to mine and analyze data from version-control systems (VCS).
66

7-
Code Maat was developed to accompany the discussions in my book [Your Code as a Crime Scene](https://pragprog.com/book/atcrime/your-code-as-a-crime-scene). Since then the analyses have evolved into [codescene.io](https://codescene.io/), which automates all the analyses found in Code Maat and beyond.
7+
Code Maat was developed to accompany the discussions in my books [Your Code as a Crime Scene](https://pragprog.com/book/atcrime/your-code-as-a-crime-scene) and
8+
[Software Design X-Rays](https://pragprog.com/book/atevol/software-design-x-rays).
9+
10+
Note that the analyses have evolved into [codescene.io](https://codescene.io/), which automates all the analyses found in Code Maat and several new ones.
811

912
[![](https://codescene.io/projects/87/status.svg) Get more details at **codescene.io**.](https://codescene.io/projects/87/jobs/latest-successful/results)
1013

@@ -24,12 +27,16 @@ Distributed under the [GNU General Public License v3.0](http://www.gnu.org/licen
2427

2528
## Usage
2629

27-
Currently, I'm not hosting any pre-built binaries. Code Maat is written in Clojure. To build it from source, use [leiningen](https://github.com/technomancy/leiningen):
30+
Code Maat is written in Clojure. To build it from source, use [leiningen](https://github.com/technomancy/leiningen):
2831

2932
lein uberjar
3033

3134
The command above will create a standalone `jar` containing all the dependencies.
3235

36+
Add the following line to your leiningen dependencies in case you want to use Code Maat as a library:
37+
38+
[code-maat "1.0.1"]
39+
3340
Code Maat operates on log files from version-control systems. The supported version-control systems are `git`, Mercurial (`hg`), `svn`, Perforce (`p4`), and Team Foundation Server (`tfs`). The log files are generated by using the version-control systems themselves as described in the following sections.
3441

3542
### Generating input data

project.clj

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
;;; Distributed under the GNU General Public License v3.0,
44
;;; see http://www.gnu.org/licenses/gpl.html
55

6-
(defproject code-maat "1.0.1"
6+
(defproject code-maat "1.1-SNAPSHOT"
77
:description "A toolset to mine and analyze version control data"
88
:url "http://www.adamtornhill.com/code/codemaat.htm"
99
:license {:name "GNU General Public License v3.0" :url "http://www.gnu.org/licenses/gpl.html"}

0 commit comments

Comments
 (0)