diff --git a/README.md b/README.md index 32c815f..ef92111 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,7 @@ -# GumTree ![Build Status](https://travis-ci.org/GumTreeDiff/gumtree.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/GumTreeDiff/gumtree/badge.svg?branch=master)](https://coveralls.io/r/GumTreeDiff/gumtree?branch=master) +# FixMiner ![Build Status](https://travis-ci.org/GumTreeDiff/gumtree.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/GumTreeDiff/gumtree/badge.svg?branch=master)](https://coveralls.io/r/GumTreeDiff/gumtree?branch=master) -GumTree is a complete framework to deal with source code as trees and compute differences between them. It includes possibilities such as: -* converting a source file into a language-agnostic tree format -* export the produced trees in various formats -* compute the differences between the trees -* export these differences in various formats -* visualize these differences graphically +# Code of FixMiner -Compared to classical code differencing tools, it has two important particularities: -* it works on a tree structure rather than a text structure, -* it can detect moved or renamed elements in addition of deleted and inserted elements. +Reference: [FixMiner: Mining Relevant Fix Patterns for Automated Program Repair](http://arxiv.org/pdf/1810.01791) (Empirical Software Engineering, [doi:10.1007/s10664-019-09780-z](https://doi.org/10.1007/s10664-019-09780-z)) -We already deal with a wide range of languages: Java, C, JavaScript and Ruby. More languages are coming soon, if you want to help contact [me](www.labri.fr/perso/falleri). - -## Citing GumTree - -We are researchers, therefore if you use GumTree in an academic work we would be really glad if you cite our seminal paper using the following bibtex: - -``` -@inproceedings{DBLP:conf/kbse/FalleriMBMM14, - author = {Jean{-}R{\'{e}}my Falleri and - Flor{\'{e}}al Morandat and - Xavier Blanc and - Matias Martinez and - Martin Monperrus}, - title = {Fine-grained and accurate source code differencing}, - booktitle = {{ACM/IEEE} International Conference on Automated Software Engineering, - {ASE} '14, Vasteras, Sweden - September 15 - 19, 2014}, - pages = {313--324}, - year = {2014}, - url = {http://doi.acm.org/10.1145/2642937.2642982}, - doi = {10.1145/2642937.2642982} -} -``` - -## Documentation - -Please consult our [wiki](https://github.com/GumTreeDiff/gumtree/wiki)