INSTALL.md, to be finished

Author: pmbittner

INSTALL.md

@@ -0,0 +1,46 @@
+# Setup Instruction
+
+You may run the demo manually, or by using Nix or Docker.
+The manual setup enables you to use DiffDetective in any of your own Maven projects.
+The Nix and Docker setups just build the demo for you to run it.
+
+## Manual Setup
+
+Check the requirements needed for the manual setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
+
+Follow the setup instructions on the [DiffDetective website](https://variantsync.github.io/DiffDetective/).
+These instructions make you clone, the repo and install it.
+Afterward, come back here and you should be ready to go.
+
+If you want an empty demo template project to implement the demo yourself, or to use for other purposes, you may
+switch to the `empty` branch.
+The `main` branch contains the full demo source code, instead.
+
+## Docker Setup
+
+Check the requirements needed for the manual setup in the [REQUIREMENTS.md](REQUIREMENTS.md) file.
+
+You can use the `docker.sh` script to build and execute the Demo using [Docker](https://www.docker.com/get-started).
+
+### Required software
+
+### Hints for Linux users
+The following hints apply for most Linux users:
+> 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).
+> See the [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
+
+> It is best to install required software (e.g., Docker, Maven) using your distro's package manager if it is available.
+
+### Setup
+Simply build the image using the provided script:
+```shell
+./docker.sh build 
+```
+
+### Execution
+Once the image has been build, you can start the demo with
+```shell
+./docker.sh demo
+```
+
+## Nix Setup

README.md

@@ -1,28 +1,14 @@
 # DiffDetective-Demo
 
-A small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective). 
-The demo is a Java maven project, which includes DiffDetective as a library.
+A small demonstration of [DiffDetective](https://github.com/VariantSync/DiffDetective). The demo is a Java Maven project, which includes DiffDetective as a library.
+You may run the demo manually, or by using Nix or Docker.
+The manual setup enables you to use DiffDetective in any of your own Maven projects.
+The Nix and Docker setups just build the demo for you to run it.
 
 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:
 
 [![DiffDetective Demonstration](docs/yt_thumbnail.png)](https://www.youtube.com/watch?v=q6ight5EDQY)
 
-
-## Setup Steps
-
-### Install Required software:
-- [Maven](https://maven.apache.org/) which is also integrated in [Eclipse](https://projects.eclipse.org/projects/technology.m2e) and [Intellij](https://www.jetbrains.com/help/idea/maven-support.html)
-- [JDK](https://www.oracle.com/java/technologies/downloads/) 16 or newer
-- [graphviz](https://graphviz.org/download/)
-
-### Install DiffDetective
-Follow the setup instructions on the [DiffDetective website](https://variantsync.github.io/DiffDetective/).
-These instructions make you clone the repo and install it.
-After installing DiffDetective, you can use it in any of your maven projects, including this demo.
-
-## Demonstration
-To run the demo, simply follow the steps in the YouTube video above.
-
-The `main` branch already contains the full demo source code.
-If you want an empty demo template project to implement the demo yourself, or to use DiffDetective for other purposes, you may
-switch to the `empty` branch.
+## Setup
+Software requirements are documented in the [REQUIREMENTS.md](REQUIREMENTS.md) file (there are no specific hardware requirements).
+The setup is documented in the [INSTALL.md](INSTALL.md) file.