From: Anthony Bargnesi <abargnesi@gmail.com>
Date: Thu, 22 Sep 2016 17:25:15 +0000 (-0400)
Subject: updated readme with build/run instructions
X-Git-Tag: javainspect-1.7~31^2~3
X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=commitdiff_plain;h=43df769cfc6cdd348868d71055c337d0871b11ec

updated readme with build/run instructions
---

diff --git a/README.md b/README.md
index f668ad3..6973374 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,28 @@ Minor enhancements:
 - Produces single executable with dependencies.
 - Default to render SVG.
 - Default to output to `user.dir` (i.e. working directory).
+
+### Building
+
+1. Install [Maven](http://maven.apache.org/).
+2. Package JAR:
+
+    `mvn clean package`
+
+### Running
+
+1. You will need to add the classes would like to visualize to your classpath.
+2. Provide a package glob pattern to identify the classes you want to visualize.
+3. Name your output.
+
+```bash
+java \
+  -cp .:/path/to/your/classes.jar:./target/javainspect-{VERSION}.jar \
+  eu.svjatoslav.inspector.java.methods.Main \
+  /home/user/work/myproject/src/main/java/ com.myproject.* myproject
+```
+
+Here we want to visualize _com.myproject.*_ classes found in
+*/home/user/work/myproject/src/main/java/*. The resulting *dot* and *svg*
+file will be prefixed with *myproject*.
+