You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Setup Instruction
1
+
# Setup Instructions
2
2
3
3
You may run the demo manually, or by using Nix or Docker.
4
4
The manual setup enables you to use DiffDetective in any of your own Maven projects.
@@ -9,25 +9,23 @@ The Nix and Docker setups just build the demo for you to run it.
9
9
Check the requirements needed for the manual setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
10
10
11
11
Follow the setup instructions on the [DiffDetective website](https://variantsync.github.io/DiffDetective/).
12
-
These instructions make you clone, the repo and install it.
12
+
These instructions make you clone the repo and install it.
13
13
Afterward, come back here and you should be ready to go.
14
14
15
-
If you want an empty demo template project to implement the demo yourself, or to use for other purposes, you may
15
+
If you want an empty demo template project to implement the demo yourself, or to use DiffDetective for other purposes, you may
16
16
switch to the `empty` branch.
17
-
The `main` branch contains the full demo source code, instead.
17
+
The `main` branch contains the full demo source code.
18
18
19
19
## Docker Setup
20
20
21
-
Check the requirements needed for the manual setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
22
-
23
-
You can use the `docker.sh` script to build and execute the Demo using [Docker](https://www.docker.com/get-started).
21
+
Check the requirements needed for the Docker setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
24
22
25
-
### Required software
23
+
You can use the `docker.sh` script to build and execute the Demo using [Docker](https://www.docker.com/get-started) as described below.
26
24
27
25
### Hints for Linux users
28
26
The following hints apply for most Linux users:
29
27
> You might require elevated privileges to execute Docker commands (e.g., `sudo ./docker.sh build` or adding the user to the `docker` or `wheel` group).
30
-
> See the[post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
28
+
> See Docker's[post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
31
29
32
30
> It is best to install required software (e.g., Docker, Maven) using your distro's package manager if it is available.
33
31
@@ -82,4 +80,4 @@ The analysis should take about 30s-5min, and its output to terminal should look
82
80
2024-04-27 11:41:40 INFO [Analysis.forEachRepository] === End Processing xterm after 53.379s ===
83
81
2024-04-27 11:41:40 INFO [AnalysisRunner.run] Done
84
82
```
85
-
The output files of the analysis should be located at [data/output](data/output).
83
+
The output files of the analysis should be located at [data/output](data/output).
0 commit comments