diff --git a/README.md b/README.md index dd8c584..1bce8e8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ This is a companion repository made available to support experimental claims of # Artefact evaluation -You will find installation guidelines and a first-step tutorial in the [getting started](./getting_started.md) guide. +You will find installation guidelines and a first-step tutorial in the [getting started](./getting_started.md) guide. +The release contains a Docker image, it can also be found along with a Virtual Machine on [Zenodo](https://zenodo.org/record/7507112#.Y7cLsKfMJhE). The entrypoint for further documentation is in the [step-by-step](./step_by_step.md) guide. In particular, it details how to replay experiments present in the paper, or a shorter version of them when they are quite long to run. diff --git a/getting_started.md b/getting_started.md index b24fd97..7ad761e 100644 --- a/getting_started.md +++ b/getting_started.md @@ -3,25 +3,10 @@ Getting Started Guide # Installation instructions -This artefact is available as a Docker or VM for VirtualBox. +We provide a docker container ready-to-use. -## VM installation - -Import the `BINSEC-ASE` VM in VirtualBox. Start it. -The user is `binsec-ase`, and the password `binsec-ase` though it should login automatically. - -The default keyboard is 'qwerty'. You can set it to 'azerty' by opening a terminal and using the command `setxkbmap fr`. +If you have issues with the docker container, we also published the same content as a VirtualBox VM. -The content of the artefact is located in the `/home/binsec-ase/artefact` folder. -``` -cd /home/binsec-ase/artefact -``` - -Note that some useful software are in `/home/binsec-ase/programs`, namely the solvers bitwuzla and boolector (z3 is also installed), the dissasembler cutter (radare2 is also installed) and the test editor vscode. - -Note that vscode is installed is the VM if you wish to use it, use can simply run `code .` then. - -See the [step-by-step](./step_by_step.md) guide for further documentation. ## Docker installation @@ -45,6 +30,28 @@ We refer the reader to the [docker manual](https://docs.docker.com/storage/volum See the [step-by-step](./step_by_step.md) guide for further documentation. + +## VM installation + +Download the [VM](https://zenodo.org/record/7507112#.Y7cLsKfMJhE). + +Import the `BINSEC-ASE` VM in VirtualBox. Start it. +The user is `binsec-ase`, and the password `binsec-ase` though it should login automatically. + +The default keyboard is 'qwerty'. You can set it to 'azerty' by opening a terminal and using the command `setxkbmap fr`. + +The content of the artefact is located in the `/home/binsec-ase/artefact` folder. +``` +cd /home/binsec-ase/artefact +``` + +Note that some useful software are in `/home/binsec-ase/programs`, namely the solvers bitwuzla and boolector (z3 is also installed), the dissasembler cutter (radare2 is also installed) and the test editor vscode. + +Note that vscode is installed is the VM if you wish to use it, use can simply run `code .` then. + +See the [step-by-step](./step_by_step.md) guide for further documentation. + + # Paper You will find a copy of the accepted paper in the artefact, named [draft.pdf](./draft.pdf). The camera-ready will be uploaded when available.