Merge remote-tracking branch 'origin/esecfse' into esecfse

Author: pmbittner

STATUS.md

@@ -1,21 +1,33 @@
+# STATUS
+## Overview
 The artifact for the paper _Classifying Edits to Variability in Source Code_ consists of four parts:
 
 1. **DiffDetective**: For our validation, we built DiffDetective, a java library and command-line tool to classify edits to variability in git histories of preprocessor-based software product lines. DiffDetective is the main artifact used to replicate the validation for our paper (see Section 5).
 2. **Appendix**: The appendix of our paper is given in PDF format in the file [`appendix.pdf`][ddappendix].
 3. **Haskell Formalization**: We provide an extended formalization in the Haskell programming language as described in our appendix. Its implementation can be found in the Haskell project in the [`proofs`][ddproofs] directory.
 4. **Dataset Overview**: We provide an overview of the 44 inspected open-source software product lines with updated links to their repositories in the file [docs/datasets.md](docs/datasets.md).
+
+## Purpose
 Our artifact has the following purposes:
 
-- **Replicability**: We provide instructions based on a docker container that allow to reproduce the validation we performed in Section 5 of our paper.
-- **Reusability**: DiffDetective is designed as a library that offers reusable functionality.
+### **Replicability**
+We provide replication instructions that allow to replicate the validation we performed in Section 5 of our paper. The replication is executed in a Docker container. 
+
+### **Reusability**
+DiffDetective is designed as a library that offers reusable functionality.
   Researchers and practitioners can use our DiffDetective library to build on our theory and results (e.g., for future prototypes to study the evolution of variability in source code).
+
   DiffDetective offers various features, including but not limited to:
   parsing variation tree diffs from unix diffs, obtaining variation tree diffs for certain patches and commits, matching elementary edit patterns on variation tree diffs, defining custom classifications, rendering, traversing, and transforming variation tree diffs, various de-/serialization methods, and running analyses for the git histories of C preprocessor-based software product lines. We documented each part of the library and provide a javadoc website within the repository.
-- **Extended Formal Specification**: The `proofs` Haskell project provides an extended formal specification of our theory.
+
+### **Extended Formal Specification**
+The `proofs` Haskell project provides an extended formal specification of our theory.
   Its main purpose is to document the theory and its extensions to serve as a reference for the proofs in our appendix.
   Yet, the project can also be used as a library to reason on variation trees and diffs in Haskell projects.
-  The library is accompanied with a small demo application that shows an example test case for our proof for completeness, by creating a variation tree diff from two variation trees and re-projecting them.
+  
+The library is accompanied with a small demo application that shows an example test case for our proof for completeness, by creating a variation tree diff from two variation trees and re-projecting them.
 
+## Claims
 We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ddgithub] and [Zenodo][ddzenodo].
 
 We claim the _Artifacts Evaluated Reusable_ badge as we implemented DiffDetective as a reusable library (see above).

proofs/INSTALL.md

@@ -11,7 +11,7 @@ Detailed installation instructions for many operating systems are given on the r
 - Windows 64-bit: Go to the [stack installation page][stackinstall]. Download and run the _Windows 64-bit Installer_.
 - MacOS: Please follow the instructions on the [installation webpage][stackinstall].
 
-Second, please open a terminal and navigate to the repository's directory (the directory containing this `INSTALL.md`).
+Second, please open a terminal and navigate to the proofs directory of this repository (the directory containing this `INSTALL.md`).
 ```shell
 cd <path/to/this/repository/proofs>
 ```
@@ -27,7 +27,7 @@ stack run
 
 ## What Is There to See
 
-Our example executes a simple test. It:
+Our example executes a simple test. It 
 1. constructs two variation trees (called `Kanto Starters` and `Johto Starters`) and prints them to terminal;
 2. diffs both trees to a variation tree diff using our [`naiveDiff`](src/VariationDiff.hs) function, which is described in our appendix, and prints the diff to terminal;
 3. creates both projections of the variation tree diff (before and after the edit) and prints both to terminal;