Skip to content

Commit c25cb4d

Browse files
AlexanderSchultheissibbem
authored andcommitted
Updated README
1 parent 3ad300c commit c25cb4d

2 files changed

Lines changed: 8 additions & 17 deletions

File tree

INSTALL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ To build the Docker container you can run the build script corresponding to your
3333
./build.sh
3434
```
3535

36-
### Validation & expected output
36+
## Validation & expected output
3737

38-
#### Running the validation
39-
To run the validation you can run the script corresponding to your OS with `validation` as first argument
38+
### Running the validation
39+
To run the validation you can run the script corresponding to your OS with `validation` as first argument. The validation should take about 10-20 minutes depending on your hardware.
4040
```
4141
# Windows:
4242
.\execute.bat validation
@@ -45,7 +45,7 @@ To run the validation you can run the script corresponding to your OS with `vali
4545
```
4646
The results of the validation are stored in the [results](results) directory.
4747

48-
#### Expected output of the validation
48+
### Expected output of the validation
4949
The aggregated results of the validation can be found in the following files.
5050

5151
- The [speed statistics](results/difftrees/speedstatistics.txt) contain information about the total runtime, median runtime, mean runtime, and more:

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ You can find detailed information on how to install Docker and build the contain
2424
### 1. Build the Docker container
2525
To build the Docker container you can run the _build_ script corresponding to your OS.
2626
#### Windows:
27-
> .\build.bat
27+
`.\build.bat`
2828
#### Linux/Mac (bash):
29-
> ./build.sh
29+
`./build.sh`
3030

3131
### 2. Start the replication
3232
To execute the replication you can run the _execute_ script corresponding to your OS with `replication` as first argument.
@@ -36,9 +36,9 @@ To execute the replication you can run the _execute_ script corresponding to you
3636
> You can run it by providing "validation" as argument instead of "replication" (i.e., ./execute.sh validation).
3737
3838
#### Windows:
39-
> .\execute.bat replication
39+
`.\execute.bat replication`
4040
#### Linux/Mac (bash):
41-
> ./execute.sh replication
41+
`./execute.sh replication`
4242

4343

4444

@@ -51,16 +51,7 @@ All raw results are stored in the [results](results) directory. The aggregated r
5151
## Haskell Formalization
5252
The extended formalization in Haskell is a library using the _Stack_ build system.
5353

54-
### Manual setup
5554
Instructions for manually installing Stack are given in [proofs/REQUIREMENTS.md](proofs/REQUIREMENTS.md).
5655
How to build our library and how to run the example is described in the [proofs/INSTALL.md](proofs/INSTALL.md).
5756

58-
### Running the example with Docker
59-
First, you have to build the Docker container as described above in the _DiffDetective_ section.
60-
Then, you can run the _execute_ script corresponding to your OS with `proofs` as first argument.
61-
#### Windows:
62-
> .\execute.bat proofs
63-
#### Linux/Mac (bash):
64-
> ./execute.sh proofs
65-
6657
[haskell]: https://www.haskell.org/

0 commit comments

Comments
 (0)