Skip to content

Commit dd5d401

Browse files
committed
Finalize the README.md
1 parent f86646f commit dd5d401

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,20 @@ Table of Contents
1717
* [With all information fetched directly from GitHub](#with-all-information-fetched-directly-from-github)
1818

1919
# General info
20-
DiffBenchmark is a visualization tool for the AST diff generated by [RefactoringMiner](https://github.com/tsantalis/RefactoringMiner).
21-
It is based on the Diff viewers provided by [GumTreeDiff](https://github.com/GumTreeDiff/gumtree).
20+
DiffBenchmark is a visualization and benchmarking tool for ASTDiff tools.
21+
It provides an infrastructure to compare the results of different ASTDiff tools with the oracle files.
22+
23+
It's extensible architecture allows you to add new ASTDiff tools and compare them with the existing ones.
24+
25+
You can visualize, compare, and evaluate the results of different ASTDiff tools using the DiffBenchmark.
2226

2327
# How to build DiffBenchmark
2428

2529
First, clone the [RefactoringMiner](https://github.com/tsantalis/RefactoringMiner.git) repository.
2630

2731
Then, you have to update the `REFACTORING_MINER_PATH` in **one** of the following ways:
2832

29-
Update the field `REFACTORING_MINER_PATH` in the `benchmark.utils.Configuration.ConfigurationFactory` class to the RefactoringMiner cloned repository path in your hard drive **or** you can have it as env variable _REFACTORING_MINER_PATH_
33+
Update the field `REFACTORING_MINER_PATH` in the `benchmark.utils.Configuration.ConfigurationFactory` class to the RefactoringMiner cloned repository path in your hard drive **or** you can have it as env variable **REFACTORING_MINER_PATH**
3034

3135
Import DiffBenchmark as a gradle project in your IDE, or run `./gradlew jar` to build.
3236

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ repositories {
1616

1717
def refactoringMinerVersion = project.hasProperty('refactoringMinerVersion') ?
1818
project.refactoringMinerVersion :
19-
'3.0.7'
19+
'3.0.8-SNAPSHOT'
2020

2121
dependencies {
2222
implementation('com.google.code.gson:gson:2.8.9')

0 commit comments

Comments
 (0)