update main readme

Author: sampalomad

README.md

@@ -4,9 +4,20 @@
 
 ## Overview
 
-This repo releases the prototype and datatsets of the `ctest` paper:
 
-**Testing Configuration Changes in Context to Prevent Production Failures**
+This repository releases the prototype and datatsets of the `ctest` paper:
+
+**[Testing Configuration Changes in Context to Prevent Production Failures](https://www.usenix.org/conference/osdi20/presentation/sun "paper")** <br/>
 In Proceedings of the 14th USENIX Symposium on Operating Systems Design and Implementation (OSDI'20), Nov. 2020.
 
-We are still working on the documents and the repo will be ready before the OSDI'20 conference.
+Please cite the paper if you use the code or the datasets.
+
+## Repository Structure
+
+### [core](https://github.com/xlab-uiuc/openctest/tree/main/core "core")
+
+ The prototype for generating and running ctests.
+ 
+### [data](https://github.com/xlab-uiuc/openctest/tree/main/data "data")
+
+ The datasets evaluated in the paper.

core/ADDING_NEW_PROJECT.md

@@ -45,7 +45,7 @@ Sometimes, the locations that need to be changed maybe in multiple `pom` files.
 
 ### 2.1 Collect Configuration Parameters and Tests
 
-*First*, collect the name, default value (empty if no default value) and description of each configuration parameters in the project. Store the information in a `tsv` file in `default_configs`. For example: [hadoop-common-default.tsv](https://github.com/xlab-uiuc/openctest/blob/master/core/default_configs/hadoop-common-default.tsv).
+*First*, collect the name, default value (empty if no default value) and description of each configuration parameters in the project. Store the information in a `tsv` file in `default_configs`. For example: [hadoop-common-default.tsv](https://github.com/xlab-uiuc/openctest/blob/main/core/default_configs/hadoop-common-default.tsv).
 
  *Second*, collect the list of configuration parameter names and put them in `openctest/core/identify_param/results/<project>/conf_params.list`. 
 
@@ -54,7 +54,7 @@ Sometimes, the locations that need to be changed maybe in multiple `pom` files.
 
 ### 2.2 Collect Deprecated Configuration Parameters
 
-Collect a mapping from the deprecated parameter name to the new parameter name. Store the information in a `tsv` file in `deprecated_configs`. The format should be the deprecated parameter name followed by the new parameter name. For example: [hadoop.list](https://github.com/xlab-uiuc/openctest/blob/master/core/deprecated_configs/hadoop.list "hadoop.list")
+Collect a mapping from the deprecated parameter name to the new parameter name. Store the information in a `tsv` file in `deprecated_configs`. The format should be the deprecated parameter name followed by the new parameter name. For example: [hadoop.list](https://github.com/xlab-uiuc/openctest/blob/main/core/deprecated_configs/hadoop.list "hadoop.list")
 
 
 ### 2.3 Automate Project Installation

core/README.md

@@ -76,11 +76,11 @@ Use **identify_param** to identify configuration parameters exercised by tests i
 3. for each configuration parameter `p`, identify tests that reset the value of `p`, and exclude `p` from these tests' exercised parameter set.
 4. generate a mapping where the keys are parameters, and values are lists of tests which exercise but not reset the parameters.
 
-Please refer to the [identify_param](https://github.com/xlab-uiuc/openctest/tree/master/core/identify_param "identify_param") folder for instructions.
+Please refer to the [identify_param](https://github.com/xlab-uiuc/openctest/tree/main/core/identify_param "identify_param") folder for instructions.
 
 #### 1.2 Generating Parameter Sets for Ctests
 
-*First*, use **generate_value** to automatically generate up to three different valid values for each parameter. The generated valid values are used to exclude tests hardcoded to specific parameter values (These tests cannot be transformed into ctests as they will fail on any other valid but different values), Please refer to the [generate_value](https://github.com/xlab-uiuc/openctest/tree/master/core/generate_value "generate_value") folder for instructions.
+*First*, use **generate_value** to automatically generate up to three different valid values for each parameter. The generated valid values are used to exclude tests hardcoded to specific parameter values (These tests cannot be transformed into ctests as they will fail on any other valid but different values), Please refer to the [generate_value](https://github.com/xlab-uiuc/openctest/tree/main/core/generate_value "generate_value") folder for instructions.
 
 *Second*, use **generate_ctest** to automatically generate ctests. It will do the following:
 
@@ -89,7 +89,7 @@ Please refer to the [identify_param](https://github.com/xlab-uiuc/openctest/tree
 3. automatically identify ctests (tests that passed on all valid values) for each parameter from the test result.
 4. output the generated "parameters -> ctests" mapping into a `json` file.
 
-Please refer to the [generate_ctest](https://github.com/xlab-uiuc/openctest/tree/master/core/generate_ctest "generate_ctest") folder for instructions.
+Please refer to the [generate_ctest](https://github.com/xlab-uiuc/openctest/tree/main/core/generate_ctest "generate_ctest") folder for instructions.
 
 ### 2. Running Ctests
 
@@ -100,4 +100,4 @@ Use **run_ctest** to run generated ctests against configuration files. It will d
  3. run selected ctests against configuration values in `D`.
  4. collect the test result for the specified configuration file.
 
-Please refer to the [run_ctest](https://github.com/xlab-uiuc/openctest/tree/master/core/run_ctest "run_ctest") folder for instructions.
+Please refer to the [run_ctest](https://github.com/xlab-uiuc/openctest/tree/main/core/run_ctest "run_ctest") folder for instructions.

core/generate_ctest/README.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-See **[Generating Parameter Sets for Ctests](https://github.com/xlab-uiuc/openctest/tree/master/core#12-generating-parameter-sets-for-ctests)**.
+See **[Generating Parameter Sets for Ctests](https://github.com/xlab-uiuc/openctest/tree/main/core#12-generating-parameter-sets-for-ctests)**.
 
 ### Instruction
 
@@ -41,7 +41,7 @@ parameter	test1	value2	test_result	testcase_time
 ...
 ```
 
-`test_result` is `p` if test passed, otherwise `f`. Skipped tests should be filtered automatically in the [Identifying Parameters Exercised in Tests](https://github.com/xlab-uiuc/openctest/tree/master/core#11-identifying-parameters-exercised-in-tests) step.
+`test_result` is `p` if test passed, otherwise `f`. Skipped tests should be filtered automatically in the [Identifying Parameters Exercised in Tests](https://github.com/xlab-uiuc/openctest/tree/main/core#11-identifying-parameters-exercised-in-tests) step.
 
 **Ctest mapping** is generated based on all the test result files in `test_result/<project>`. It is stored in `ctest_mapping/ctests-<project>.json` with format:
 ```

core/generate_value/README.md

@@ -3,7 +3,7 @@
 
 ### Introduction
 
-See [Generating Ctests - generating valid values](https://github.com/xlab-uiuc/openctest_prerelease/blob/master/core/README.md#12-generating-parameter-sets-for-ctests).
+See [Generating Ctests - generating valid values](https://github.com/xlab-uiuc/openctest/blob/main/core/README.md#12-generating-parameter-sets-for-ctests).
 
 ### Instruction
 

core/identify_param/README.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-See [Identifying Parameters Exercised in Tests](https://github.com/xlab-uiuc/openctest/tree/master/core#11-identifying-parameters-exercised-in-tests)
+See [Identifying Parameters Exercised in Tests](https://github.com/xlab-uiuc/openctest/tree/main/core#11-identifying-parameters-exercised-in-tests)
 
 
 ### Instruction

core/run_ctest/README.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-See **[Running Ctests](https://github.com/xlab-uiuc/openctest/tree/master/core#2-running-ctests)**.
+See **[Running Ctests](https://github.com/xlab-uiuc/openctest/tree/main/core#2-running-ctests)**.
 
 ### Instruction
 
@@ -39,7 +39,7 @@ ctest2	test_result	testcase_time
 ...
 ```
 
-`test_result` is `p` if ctest passed, otherwise `f`. Skipped tests should be filtered automatically during [ctest generation](https://github.com/xlab-uiuc/openctest/tree/master/core#1-generating-ctests).
+`test_result` is `p` if ctest passed, otherwise `f`. Skipped tests should be filtered automatically during [ctest generation](https://github.com/xlab-uiuc/openctest/tree/main/core#1-generating-ctests).
 
 
 ### Directory Structure