-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix link and document other requirements
- Loading branch information
1 parent
13af0f4
commit 78e96d4
Showing
5 changed files
with
41 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
INSTALL.md | ||
../INSTALL.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
LICENSE | ||
../LICENSE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
README.md | ||
../README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,28 @@ | ||
# Recommended requirements | ||
|
||
In this set-up, the reader considers this code mainly as the artifact for our | ||
paper, and thus wants to check it is working properly. To that end, we propose | ||
to interact in an easy way with a Docker container containing our code. The main | ||
requirement for the reader is to have [Docker](https://www.docker.com) and | ||
[VSCode](https://code.visualstudio.com) installed on their machine. You also | ||
need to ensure you have more than 6GB of disk space available. | ||
# Requirements | ||
|
||
According to the path you want to follow there are different sets of | ||
requirements. | ||
|
||
## Using github codespaces | ||
|
||
You need to have remaining minutes of usage in your Codespaces plan. | ||
Unless you are often using Codespaces for free, this requirement | ||
should be met. | ||
|
||
## Using VSCode | ||
|
||
The main requirement is to have [Docker](https://www.docker.com) and | ||
[VSCode](https://code.visualstudio.com) installed on their machine. | ||
VSCode must have permission to run Docker. You also need to ensure | ||
you have more than 6GB of disk space available. | ||
|
||
## Using opam | ||
|
||
You need to have [opam](https://opam.ocaml.org/doc/Install.html) | ||
properly installed. | ||
|
||
## Using nix | ||
|
||
You need to have either the nix package manager installed on your | ||
system (Linux, MacOS, WSL2) via https://nixos.org/download or a NixOS | ||
linux distribution. |