Skip to content

Commit 6a70673

Browse files
committed
Some README refinements
1 parent 1c3c9c3 commit 6a70673

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# DiffDetective-Demo
22

3-
A small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective). The demo is a Java Maven project, which includes DiffDetective as a library.
4-
You may run the demo manually, or by using Nix or Docker.
5-
The manual setup enables you to use DiffDetective in any of your own Maven projects.
6-
The Nix and Docker setups just build the demo for you to run it.
3+
A small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective).
4+
The idea of this demo is to serve as an example for how to use DiffDetective, as well as a template project for you to clone and adapt as a quickstart for developing with DiffDetective.
75

8-
This demo comes with a screencast available on YouTube, guiding you through the demo's setup with Maven in IntelliJ and how to implement variability-aware differencing and analyses of Git histories:
6+
There is a screencast available on YouTube, guiding you through the demo's setup with Maven in IntelliJ and how to implement variability-aware differencing and analyses of Git histories:
97

108
[![DiffDetective Demonstration](docs/yt_thumbnail.png)](https://www.youtube.com/watch?v=q6ight5EDQY)
119

1210
## Setup
11+
12+
The demo is a Java Maven project, which includes DiffDetective as a library.
13+
You may run the demo manually, or by using Nix or Docker.
14+
The manual setup enables you to use DiffDetective in any of your own Maven projects.
15+
The Nix and Docker setups just build the demo for you to run it.
16+
1317
Software requirements are documented in the [REQUIREMENTS.md](REQUIREMENTS.md) file (there are no specific hardware requirements).
14-
The setup is documented in the [INSTALL.md](INSTALL.md) file.
18+
Basically, you will have to install Java and Maven, or alternatively Nix or Docker.
19+
20+
Installation instructions are documented in the [INSTALL.md](INSTALL.md) file.
21+

0 commit comments

Comments
 (0)