Skip to content

Commit e14a16c

Browse files
committed
setup instructions
1 parent 2bd65fe commit e14a16c

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,37 @@ Additionally, DiffDetective offers a **flexible framework for large-scale empiri
1616

1717
## Setup
1818

19-
DiffDetective is a Java Maven library.
19+
DiffDetective is a Java Maven library. While DiffDetective depends on some custom libraries ([FeatureIDE library](https://featureide.github.io/), [Sat4j](https://sat4j.org/), [Functjonal](https://github.com/VariantSync/Functjonal)) these are prepackaged with DiffDetective. So **all you need is [Maven](https://maven.apache.org/)** installed.
2020

21-
...
21+
DiffDetective also comes as a **nix package** (see [default.nix](default.nix)).
22+
23+
### Setup with Maven
24+
25+
First, clone this repository and navigate inside it:
26+
```shell
27+
git clone https://github.com/VariantSync/DiffDetective
28+
cd DiffDetective
29+
```
30+
31+
Second, build DiffDetective and install it on your system so that you can access it from your own projects:
32+
```shell
33+
mvn install
34+
```
35+
36+
DiffDetective is now available on your system. Add the following to the pom.xml of your Maven project to add DiffDetective as a dependency, but make sure to pick the right version. You can the current version of DiffDetective you installed at the top of the pom.xml file in DiffDetective.
37+
38+
```xml
39+
<dependency>
40+
<groupId>org.variantsync</groupId>
41+
<artifactId>DiffDetective</artifactId>
42+
<version>2.0.0</version>
43+
</dependency>
44+
```
45+
46+
If you prefer to just use a jar file, you can find a jar file with all dependencies in `DiffDetective/target/diffdetective-2.0.0-jar-with-dependencies.jar` (again, the version number might be different).
47+
You can (re-)produce this jar file by either running `mvn package` or `mvn install` within you local clone of DiffDetective.
48+
49+
> Disclaimer: Setup tested with maven version 3.6.3.
2250
2351
## Publications
2452

0 commit comments

Comments
 (0)