Skip to content

Commit 89ba8c4

Browse files
committed
complete manual INSTALL instructions
1 parent 508bf21 commit 89ba8c4

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

INSTALL.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,21 @@ Follow the setup instructions on the [DiffDetective website](https://variantsync
1212
These instructions make you clone the repo and install it.
1313
Afterward, come back here and you should be ready to go.
1414

15-
If you want an empty demo template project to implement the demo yourself, or to use DiffDetective for other purposes, you may
16-
switch to the `empty` branch.
17-
The `main` branch contains the full demo source code.
15+
To run the demo, you can do so via an IDE or terminal.
16+
In our screencast, we show how to build and run the Demo in IntelliJ.
17+
Alternatively, here we show how to build and run the demo on the command line.
18+
19+
Open a terminal and navigate to the top level of this repository.
20+
You can then build the demo running the following Maven command:
21+
```shell
22+
mvn package
23+
```
24+
Afterward, the jar files can be found in the `target` directory as the build output.
25+
To run the demo, invoke `java` on the jar file that includes any dependencies:
26+
```shell
27+
java -jar target/diffdetectivedemo-1.0.0-jar-with-dependencies.jar
28+
```
29+
The expected output and behavior of the jar file is explained below in the section _Expected Output_.
1830

1931
## Docker Setup
2032

0 commit comments

Comments
 (0)