Skip to content

Commit

Permalink
Update GETTING_STARTED.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CohenCyril authored Jan 4, 2024
1 parent 5d3f75f commit a6198b6
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions artifact-clean/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,14 @@ This artifact contains an implementation of the Trocq parametricity framework as

## Testing the code (recommended)

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.
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.

Here are the instructions:
- Pull the Docker image containing our code.
```shell
docker pull cohencyril/trocq
```
- Run a Docker container from this image and leave this terminal on the side.
```shell
docker run --rm -it -v bash cohencyril/trocq
docker run -d bash cohencyril/trocq
```
- Start VSCode on the host and install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.
- Start VSCode on the host and install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension or run `code --install-extension ms-vscode-remote.remote-containers`
- Click on the `><` button at the bottom left-hand corner of the window.
A menu opens in the middle.
- Choose `Attach to Running Container...` and select the container that is based on the `cohencyril/trocq` image.
Expand All @@ -33,4 +29,4 @@ In file `artifact_paper_example.v`, this amounts to putting the pointer on line

## Installing the plugin

In this set-up, the reader is a regular Coq user and might want to install the plugin for further use in their proofs. In this case, the recommended way to proceed is to clone the [Trocq repository](https://github.com/coq-community/trocq/) and follow instructions in the `README`. In particular, two options are available to install Trocq, according to personal preference, one through the `opam` package manager and the other through Nix.
In this set-up, the reader is a regular Coq user and might want to install the plugin for further use in their proofs. In this case, the recommended way to proceed is to clone the [Trocq repository](https://github.com/coq-community/trocq/) and follow instructions in the `README`. In particular, two options are available to install Trocq, according to personal preference, one through the `opam` package manager and the other through Nix.

0 comments on commit a6198b6

Please sign in to comment.