Skip to content

Commit

Permalink
Improve ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
Inventitech committed Dec 9, 2016
1 parent 5bfa094 commit c5c7824
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,18 @@ This tool is for creating a visualization of the warnings/defects that were gene

## Building
* Run `mvn package`.
* If you want to develop UAV, please install Lombok to auto-generate getters and setters. (Via `java -jar lib/lombok.jar install path/to/your/ide`)
* If you want to contribute to UAV's development, please install Lombok to auto-generate getters and setters. (Via `java -jar lib/lombok.jar install path/to/your/ide`)

## Running the Program:
Running UAV is simple: After building it, the latest executable Jar has been conviently placed in the project's base folder. All you have to do is:
* Start UAV via `java -jar UnifiedASATVisualizer-1.1.2.jar`
* Follow the instruction on UAV's User Interface.
* Select the top-level project directory (on your computer) that you want to visualize.
* Click the `Visualize` button. Depending on the project's size and number of warnings, this may take some time to generate the HTML visualization.
* If the visualization does not open automatically (known problems with Linux) or the Java application appears to have crashed, manually open ./visualization/main.html in Chrome or Safari.

UAV requires you to run on a Java project with ASAT warnings generated via `maven site`. Many famous projects include this already, but if you want to analyze a project which does not, here is how you do it:

* Add the following snippet to the project's pom.xml file that you want to analyze:

```XML
Expand Down Expand Up @@ -57,8 +66,4 @@ This tool is for creating a visualization of the warnings/defects that were gene
Copy the whole snippet **only** if you do not have `<reporting>` in your pom.xml. If you do, then just copy the plugins. For more information on how to exclude certain files or how to use specific rulesets, please check the following links: ([FindBugs](http://gleclaire.github.io/findbugs-maven-plugin/usage.html), [CheckStyle](https://maven.apache.org/plugins/maven-checkstyle-plugin/usage.html), [PMD](https://maven.apache.org/plugins/maven-pmd-plugin/usage.html))

* Run `mvn site` on the project you want to analyze (this generates the ASAT reports which are read-in by UAV).
* Start UAV via `java -jar uav.jar`
* Follow the instruction on UAV's User Interface.
* Select the top-level project directory (on your computer) that you want to visualize.
* Click the `Visualize` button. Depending on the project's size and number of warnings, this may take some time to generate the HTML visualization.
* If the visualization does not open automatically (known problems with Linux) or the Java application appears to have crashed, try manually opnening visualization/main.html in Chrome or Safari.

0 comments on commit c5c7824

Please sign in to comment.