Skip to content

Commit 4a6b678

Browse files
docs: update README
1 parent 6aa6084 commit 4a6b678

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The reproduction package consists of three main parts:
3131

3232
1. [**mpatch**](/mpatch/README.md): The implementation of our novel match-based patcher, written in Rust.
3333
2. [**Mined cherries**](dataset/): Our dataset of cherry picks mined from 5,000 GitHub repositories.
34-
3. [**Empirical evaluation**](src/main/kotlin/org/variantsync/evaluation/PatcherEvaluationMain.kt): Our empirical evaluation of different language-agnostic patchers.
34+
3. [**Empirical evaluation**](src/main/kotlin/org/variantsync/evaluation/PatcherEvaluationMain.kt): Our empirical evaluation of various language-agnostic patchers.
3535

3636
## Requirements
3737

@@ -63,20 +63,16 @@ Our evaluation can be reproduced on any system supporting [Docker](https://docs.
6363
Docker will take care of all requirements and dependencies to reproduce our evaluation.
6464

6565
- We recommend running the evaluation on a system with at least **64GB** of primary memory (RAM).
66-
- 100GB—2TB of free drive space, depending on the configuration of the Docker image.
67-
68-
### Other Requirements
69-
70-
- A stable internet connection.
66+
- 100GB — 2TB of free drive space, depending on the configuration of the Docker image.
7167

7268
## Installation
7369

7470
### [Optional] Configuration
7571

76-
Before building the Docker image, you may **optionally** configure how the evaluation is executed.
72+
Before building the Docker image, you may **optionally** configure how the evaluation is executed, if you plan on running the full reproduction.
7773
To this end, we provide two configuration files: [config-reproduction.properties](docker/config-reproduction.properties) for the configuration of the reproduction of the entire evaluation, and [config-verification.properties](docker/config-verification) for the verification of the correct installation of the reproduction package.
7874

79-
Depending on the available hardware, you may need to adjust the following settings:
75+
Depending on the available hardware, you may want to adjust the following settings in the [config-reproduction.properties](docker/config-reproduction.properties):
8076

8177
- The number of threads used (i.e., how many repositories are processed in parallel). Please note that each thread requires an additional `40GB` of free space on your drive.
8278
- Whether all repositories should be cloned before the evaluation. This eliminates the need for a stable internet connection once all repositories have been cloned.

0 commit comments

Comments
 (0)