|
1 | | -# Installation Instructions |
| 1 | +# Installation and Setup |
| 2 | + |
| 3 | +## Maven Dependency |
| 4 | + |
| 5 | +Boomerang, IDEal and the scopes are released on Maven Central. |
| 6 | +Depending on whether you want to use Boomerang or IDEal, include the following dependencies in your project (replace `x.y.z` with the latest version): |
| 7 | + |
| 8 | +- Boomerang can be included with the following dependency: |
| 9 | + |
| 10 | +```bash |
| 11 | +<dependency> |
| 12 | + <groupId>de.fraunhofer.iem</groupId> |
| 13 | + <artifactId>boomerangPDS</artifactId> |
| 14 | + <version>x.y.z</version> |
| 15 | +</dependency> |
| 16 | +``` |
| 17 | + |
| 18 | +- IDEal can be included with the following dependency: |
| 19 | + |
| 20 | +```bash |
| 21 | +<dependency> |
| 22 | + <groupId>de.fraunhofer.iem</groupId> |
| 23 | + <artifactId>idealPDS</artifactId> |
| 24 | + <version>x.y.z</version> |
| 25 | +</dependency> |
| 26 | +``` |
| 27 | + |
| 28 | +Additionally, Boomerang and IDEal require a concrete scope implementation to run with a static analysis framework. |
| 29 | +Depending on the desired framework, include the following dependencies (see the [FrameworkScopes](../general/framework_scopes.md) for more information): |
| 30 | + |
| 31 | +=== "Soot" |
| 32 | + ``` |
| 33 | + <dependency> |
| 34 | + <groupId>de.fraunhofer.iem</groupId> |
| 35 | + <artifactId>boomerangScope-Soot</artifactId> |
| 36 | + <version>x.y.z</version> |
| 37 | + </dependency> |
| 38 | + ``` |
| 39 | + |
| 40 | +=== "SootUp" |
| 41 | + ``` |
| 42 | + <dependency> |
| 43 | + <groupId>de.fraunhofer.iem</groupId> |
| 44 | + <artifactId>boomerangScope-SootUp</artifactId> |
| 45 | + <version>x.y.z</version> |
| 46 | + </dependency> |
| 47 | + ``` |
| 48 | + |
| 49 | +=== "Opal" |
| 50 | + ``` |
| 51 | + <dependency> |
| 52 | + <groupId>de.fraunhofer.iem</groupId> |
| 53 | + <artifactId>boomerangScope-Opal</artifactId> |
| 54 | + <version>x.y.z</version> |
| 55 | + </dependency> |
| 56 | + ``` |
| 57 | + |
| 58 | +## Building the Project locally |
| 59 | + |
| 60 | +Boomerang uses Maven as build tool. |
| 61 | +You can compile and install this project on your machine via the command |
| 62 | + |
| 63 | +```bash |
| 64 | +mvn clean install -DskipTests |
| 65 | +``` |
0 commit comments