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: REQUIREMENTS.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,22 @@ None
4
4
5
5
## Software Requirements
6
6
7
+
> This demo can be run with Docker or Nix. If you intend to use one of them, you may skip to the last section in this README.
8
+
7
9
We do not require a certain operating system or prepared environment.
8
10
For downloading this demo, we recommend Git (installing Git is explained in [this article](https://github.com/git-guides/install-git)).
9
11
The setup is tested on Windows 10, WSL2, Manjaro, Ubuntu, and MacOS Monterey.
10
12
11
-
This demo is a Maven project based on Java 17.
12
-
The demo has a few dependencies, most of which will be handled automatically by Maven.
13
+
### Toolchain
14
+
This demo is a Maven project based on Java 17. Thus, it requires a [Java development toolik](https://www.oracle.com/java/technologies/downloads/) of version 17 or higher, and [Maven](https://maven.apache.org/).
15
+
16
+
### Java Dependencies
17
+
The demo has few dependencies, most of which will be handled automatically by Maven.
13
18
The dependencies are documented in the Maven build file ([pom.xml](pom.xml)).
14
19
The only dependency that must be installed manually is our tool and library DiffDetective, which is also a Java Maven project.
15
20
Installing DiffDetective follows the default maven workflow and is explained on the [DiffDetective website](https://variantsync.github.io/DiffDetective/) and README.
16
21
22
+
## Virtualization: Docker or Nix
17
23
For easy replication, this demo also comes with a Nix package and a Docker container, which can be used on any system supporting Nix or Docker, respectively.
18
24
The Nix and Docker setup will take care of all requirements and dependencies (including DiffDetective) and will build the demo to a single runnable JAR file.
19
25
_Note_: Nix and Docker are neither required by the demo nor DiffDetective! They only serve to ease the setup for you. You may use either Nix or Docker but you do not need both.
@@ -26,4 +32,4 @@ How to install Docker depends on your operating system:
26
32
27
33
How to install Nix, also depends on your operating system.
28
34
Head to the [NixOS website](https://nixos.org/download/) and follow the installation instructions for your system.
29
-
Follow the download instructions for `Nix: the package manager`, not `NixOS: the Linux distribution`!
35
+
Follow the download instructions for `Nix: the package manager`, not `NixOS: the Linux distribution`!
0 commit comments