Skip to content

Commit

Permalink
Fix link and document other requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
CohenCyril committed Jan 11, 2024
1 parent 13af0f4 commit 78e96d4
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 20 deletions.
19 changes: 10 additions & 9 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@ interest in our work for their own use. All methods were tested on Linux and
macOS, we therefore recommend that the reader use one of these operating
systems.

### Via codespaces (browser setup)
### Via codespaces (recommended browser setup)

[Open codespaces](https://github.com/codespaces/new?skip_quickstart=true&machine=standardLinux32gb&repo=717137925&ref=master&devcontainer_path=.devcontainer%2Fdevcontainer.json&geo=EuropeWest) and click "Create codespace".

### Via VSCode and Docker (machine setup)
### Via VSCode and Docker (recommended machine setup)

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, VSCode must have
permission to run Docker.
You also need to ensure you have more than 6GB of disk space available.
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. VSCode must have permission to run Docker. You also need to
ensure you have more than 6GB of disk space available.

The container with all the dependencies is accessible on Dockerhub as [`cohencyril/trocq-deps`](https://hub.docker.com/repository/docker/cohencyril/trocq-deps) and the corresponding `Dockerfile` is in [.devcontainer/Dockerfile](https://github.com/coq-community/trocq/blob/master/.devcontainer/Dockerfile) in this repo. You could run it manually using `docker run -it cohencyril/trocq-deps` but you would not be able to run VSCode in the docker terminal, hence the setup described below.

Expand Down
2 changes: 1 addition & 1 deletion artifact-doc/INSTALL.md
2 changes: 1 addition & 1 deletion artifact-doc/LICENSE
2 changes: 1 addition & 1 deletion artifact-doc/README.md
36 changes: 28 additions & 8 deletions artifact-doc/REQUIREMENTS.md
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.

0 comments on commit 78e96d4

Please sign in to comment.