From bdf26ec8768deb85177672682fc8cd6f653b6602 Mon Sep 17 00:00:00 2001
From: Rishi Vijayvargiya <54428932+rishivijayv@users.noreply.github.com>
Date: Thu, 14 Nov 2024 16:20:41 +0100
Subject: [PATCH 1/3] Add documentation for GraalVM installation in setup

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96f8593369..bcac9e8a02 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,8 @@ brew install gh
 
 You must install Java 8, 11 and 17. You must set the `JAVA8_HOME`, `JAVA11_HOME` and `JAVA17_HOME` environment variables to the respective Java installations.
 
----
+By default, you should install [GraalVM](https://www.graalvm.org/downloads/) (version 21 or later) and set a `GRAALVM_HOME` environment variable to the home of the GraalVM JDK installation.
+(Todo: the pipeline should be made to work with regular JDK.  The correctness outputs will be reliable, but no timing information should be output.)
 
 ## Run the code
 

From 331aba27b787b796a7234f4c9a6850a002496ecf Mon Sep 17 00:00:00 2001
From: Michael Ernst <mernst@cs.washington.edu>
Date: Thu, 14 Nov 2024 07:41:27 -0800
Subject: [PATCH 2/3] Add overview to README

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bcac9e8a02..a26ac0b811 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,28 @@
 ![check-style](https://github.com/benedikt-schesch/AST-Merging-Evaluation/actions/workflows/check-style.yml/badge.svg)
 ![check-reproducibility](https://github.com/benedikt-schesch/AST-Merging-Evaluation/actions/workflows/check-reproducibility.yml/badge.svg)
 
+This is an experimental framework for comparing version control merging algorithms.
+It runs each merge tool on 6045 real-world merges.
+It classifies each merge as a conflict, a correct merge, or an incorrect merge.
+It uses each project's test suite to determine whether the merge was correct,
+and it penalizes merge tools for creating incorrect merges.
+
+The paper [Evaluation of Version Control Merge
+Tools](https://homes.cs.washington.edu/~mernst/pubs/merge-evaluation-ase2024-abstract.html)
+evaluates 16 merge algorithms, including
+[Hires-Merge](https://github.com/paulaltin/git-hires-merge),
+[IntelliMerge](https://github.com/Symbolk/IntelliMerge),
+[Plume-lib Merging](https://github.com/plume-lib/merging), and
+[Spork](https://github.com/ASSERT-KTH/spork).
+Since then, the framework has been expanded to evaluate newer algorithms,
+such as
+[Mergiraf](https://mergiraf.org/).
+
 ## Requirements
 
 ### Download the cached data
 
-Download the compressed cached data [here](https://zenodo.org/records/13366866) and put it in the root directory of the project. Be aware the the uncompressed cache size is 84GB as of 09-23-2024.
+Download the compressed cached data [here](https://zenodo.org/records/13366866) and put it in the root directory of the project. Be aware the the uncompressed cache size is 84GB as of 2024-09-23.
 
 ### Python
 

From cda753d5d11a7643aa3f59b4df4a796bdb59a86d Mon Sep 17 00:00:00 2001
From: Michael Ernst <mernst@cs.washington.edu>
Date: Thu, 14 Nov 2024 08:57:30 -0800
Subject: [PATCH 3/3] Instructions for adding a new merge tool

---
 src/scripts/merge_tools/README | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/scripts/merge_tools/README b/src/scripts/merge_tools/README
index 228bc7b0bb..412bc16d24 100644
--- a/src/scripts/merge_tools/README
+++ b/src/scripts/merge_tools/README
@@ -1 +1,7 @@
-git-hires-merge is from https://github.com/paulaltin/git-hires-merge .
+To add a new merging tool to the evaluation:
+ * Add a new script here, `mytool.sh`
+ * Create a `mytool_plus.sh` script that runs the new merging tool and then
+   Plume-lib Merging.  (You can copy from `spork_plus.sh`.)
+ * Update the expected results so that the CI tests pass.
+
+File `git-hires-merge` is from https://github.com/paulaltin/git-hires-merge .