Skip to content

Commit 16bb0cd

Browse files
pmbittneribbem
authored andcommitted
Update INSTALL.md
1 parent 4933acb commit 16bb0cd

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

INSTALL.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ In the following, we describe how to build the Docker image and run the experime
66
How to install Docker depends on your operating system.
77

88
#### Windows or Mac
9-
You can find download and installation instructions [here](https://www.docker.com/get-started).
9+
You can find download and installation instructions [here](https://www.docker.com/get-started).
10+
1011
#### Linux Distributions
11-
How you can install Docker on your system, depends on your distribution. However, the chances are high that Docker is part of your distributions package database.
12+
How to install Docker on your system, depends on your distribution. However, the chances are high that Docker is part of your distributions package database.
1213
Docker's [documentation](https://docs.docker.com/engine/install/) contains instructions for common distributions.
1314

14-
### Open a suitable terminal
15+
### Open a Suitable Terminal
1516
```
1617
# Windows Command Prompt:
1718
- Press 'Windows Key + R' on your keyboard
@@ -25,7 +26,8 @@ Docker's [documentation](https://docs.docker.com/engine/install/) contains instr
2526
# Linux:
2627
- Press 'ctrl + alt + T' on your keyboard
2728
```
28-
### Build the Docker container
29+
30+
### Build the Docker Container
2931
To build the Docker container you can run the build script corresponding to your OS
3032
```
3133
# Windows:
@@ -34,19 +36,19 @@ To build the Docker container you can run the build script corresponding to your
3436
./build.sh
3537
```
3638

37-
## Validation & expected output
39+
## Validation & Expected Output
3840

39-
### Running the validation
41+
### Running the Validation
4042
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.
4143
```
4244
# Windows:
4345
.\execute.bat validation
4446
# Linux/Mac (bash):
4547
./execute.sh validation
4648
```
47-
The results of the validation are stored in the [results](results) directory.
49+
The results of the validation will be stored in the [results](results) directory.
4850

49-
### Expected output of the validation
51+
### Expected Output of the Validation
5052
The aggregated results of the validation can be found in the following files.
5153

5254
- The [speed statistics](results/difftrees/speedstatistics.txt) contain information about the total runtime, median runtime, mean runtime, and more:
@@ -93,6 +95,9 @@ The aggregated results of the validation can be found in the following files.
9395
#Error[#else or #elif without #if]: 9
9496
#Error[not all annotations closed]: 6
9597
```
98+
99+
(Note that the above links only have a target after running the validation.)
100+
The processing times might deviate.
96101

97102
## Troubleshooting
98103

@@ -104,10 +109,10 @@ The aggregated results of the validation can be found in the following files.
104109
### 'Unable to find image 'replication-package:latest' locally'
105110
`Problem:` The Docker container could not be found. This either means that the name of the container that was built does not fit the name of the container that is being executed (this only happens if you changed the provided scripts), or that the Docker container was not built yet.
106111

107-
`Fix:` Build the Docker container.
112+
`Fix:` Follow the instructions described above in the section `Build the Docker Container`.
108113

109114
### No results after validation, or 'cannot create directory '../results/difftrees': Permission denied'
110115
`Problem:` This problem can occur due to how permissions are managed inside the Docker container. More specifically, it will appear, if Docker is executed with elevated permissions (i.e., `sudo`) and if there is no [results](results) directory because it was deleted manually. In this case, Docker will create the directory with elevated permissions, and the Docker user has no permissions to access the directory.
111116

112117
`Fix:` If there is a _results_ directory delete it with elevated permission (e.g., `sudo rm -r results`).
113-
Then, create a new _results_ directory without elevated permissions, or execute `git restore .` to restore the deleted directory.
118+
Then, create a new _results_ directory without elevated permissions, or execute `git restore .` to restore the deleted directory.

0 commit comments

Comments
 (0)