Skip to content

Commit 6f175fb

Browse files
committed
fix: nix setup instructions for WSL2 and Win
1 parent 775f26b commit 6f175fb

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

INSTALL.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
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.
55
The Nix and Docker setups just build the demo for you to run it.
6+
Windows users should _not_ use the Nix setup except if they have experience with WSL2, XServers, and Nix (see [REQUIREMENTS.md](REQUIREMENTS.md)).
67

78
## Manual Setup
89

@@ -66,7 +67,13 @@ See [REQUIREMENTS.md](REQUIREMENTS.md) for instructions on how to install Nix an
6667

6768
### Standalone Build
6869

69-
If you have flake's enabled, you can just use
70+
> Notice for Windows users:
71+
> You must run the following commands from within a WSL2 terminal.
72+
> Also, make sure to clone this repository to a directory within WSL and _not_ to a Windows directory.
73+
> Otherwise, the Nix setup might fail due to incompatibilities with the file system.
74+
> Moreover, if you would like to have access to the demo's GUI, you need an XServer installed (see [REQUIREMENTS.md](REQUIREMENTS.md)).
75+
76+
If you have flakes enabled, you can just use
7077
```shell
7178
nix run github:VariantSync/DiffDetective-Demo
7279
```

0 commit comments

Comments
 (0)