Skip to content

Commit fb579b1

Browse files
committed
README points out that this is not a replication package
1 parent d506ef5 commit fb579b1

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

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

3-
A small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective).
3+
This is a small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective).
44
The purpose of this demo is to provide an example of how to use DiffDetective and to serve as a template project for you to clone and adapt as a quickstart for developing with DiffDetective.
55

66
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:
@@ -10,16 +10,14 @@ There is a screencast available on YouTube, guiding you through the demo's setup
1010
This demo, also manifests the artifact submission for our paper _Variability-Aware Differencing with DiffDetective_, accepted at the FSE'24 demonstrations track.
1111
A preprint of the paper is available as part of this repository, [here](Variability-Aware%20Differencing%20with%20DiffDetective.pdf).
1212
Our application for artifact badges can be found in the [STATUS.md](STATUS.md) file.
13+
Please not that this submission is _not_ a replication package of an empirical study (e.g., tool evaluation).
14+
Instead, this repository is a template project with examples for how to use DiffDetective (i.e., a demo).
1315

1416
## Setup
1517

1618
The demo is a Java Maven project, which includes DiffDetective as a library.
17-
You may run the demo manually, or by using Nix or Docker.
18-
The manual setup enables you to use DiffDetective in any of your own Maven projects.
19-
The Nix and Docker setups just build the demo for you to run it.
2019

2120
Software requirements are documented in the [REQUIREMENTS.md](REQUIREMENTS.md) file (there are no specific hardware requirements).
2221
Basically, you will have to install Java and Maven, or alternatively Nix or Docker.
2322

2423
Installation instructions are documented in the [INSTALL.md](INSTALL.md) file.
25-

0 commit comments

Comments
 (0)