Skip to content

Commit 48db7c0

Browse files
docs: revise INSTALL.md
1 parent 6790c93 commit 48db7c0

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

INSTALL.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setup Instruction
1+
# Setup Instructions
22

33
You may run the demo manually, or by using Nix or Docker.
44
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.
99
Check the requirements needed for the manual setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
1010

1111
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.
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 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
1616
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.
1818

1919
## Docker Setup
2020

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.
2422

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.
2624

2725
### Hints for Linux users
2826
The following hints apply for most Linux users:
2927
> 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.
3129
3230
> It is best to install required software (e.g., Docker, Maven) using your distro's package manager if it is available.
3331
@@ -82,4 +80,4 @@ The analysis should take about 30s-5min, and its output to terminal should look
8280
2024-04-27 11:41:40 INFO [Analysis.forEachRepository] === End Processing xterm after 53.379s ===
8381
2024-04-27 11:41:40 INFO [AnalysisRunner.run] Done
8482
```
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

Comments
 (0)