Skip to content

Commit bc56f7c

Browse files
committed
INSTALL: extended Nix instructions
1 parent bdf2ec7 commit bc56f7c

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

INSTALL.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,18 +117,26 @@ See [REQUIREMENTS.md](REQUIREMENTS.md) for instructions on how to install Nix an
117117
> Otherwise, the Nix setup might fail due to incompatibilities with the file system.
118118
> Moreover, if you would like to have access to the demo's GUI, you need an XServer installed (see [REQUIREMENTS.md](REQUIREMENTS.md)).
119119
120-
Clone and navigate to this repository.
121-
Then simply build and run the Demo using
120+
> Notice for Nix flake users:
121+
> If you have flakes enabled, you can just use `nix run github:VariantSync/DiffDetective-Demo` to run the demo instead of the following instructions.
122+
123+
Clone and navigate to this repository in a terminal.
124+
Then simply build the Demo with
122125
```shell
123126
nix-build
124-
./result/bin/DiffDetective-Demo
125127
```
126128
127-
If you have flakes enabled, you can instead just use
129+
Afterwards, the produced jar file is located at `result/share/java/DiffDetective-Demo.jar`.
130+
You can run it manually with Java (requires Java 17 or higher):
131+
```shell
132+
java -jar result/share/java/DiffDetective-Demo.jar
133+
```
134+
or alternatively via nix:
128135
```shell
129-
nix run github:VariantSync/DiffDetective-Demo
136+
./result/bin/DiffDetective-Demo
130137
```
131138
139+
132140
## Expected Output
133141
134142
The expected output is close to the output shown at the end of the [screencast](https://www.youtube.com/watch?v=q6ight5EDQY).

0 commit comments

Comments
 (0)