X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=README.md;h=5ffec69cb76df9af0f7020fc3059757d44c587d6;hb=b5ce3bd895a6e6c2253e070cfce197a244c78c4c;hp=f668ad3e3033d8dc91ee3a9e34c3b80893678b97;hpb=6101cbd91218bce7cc2b00ddbfca329bf5cdaf31;p=javainspect.git diff --git a/README.md b/README.md index f668ad3..5ffec69 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,33 @@ 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 .:./example/target/myproject-0.0.jar:./target/javainspect-1.6-SNAPSHOT.jar \ + eu.svjatoslav.inspector.java.methods.Main \ + ./example/src/main/java/ com.myproject.* myproject +``` + +Here we want to visualize _com.myproject.*_ classes found in +*./example/src/main/java/*. The resulting *dot* and *svg* +file will be prefixed with *myproject*. + +### Output example + +![MyProject output](https://github.com/abargnesi/javainspect/raw/master/myproject.png) + +The [dot](https://github.com/abargnesi/javainspect/raw/master/myproject.dot) file is also saved.