Files
java-diff-utils/README.md
wumpz 26c361565e
2017-04-10 17:10:28 +02:00

47 lines
1.9 KiB
Markdown

# java-diff-utils
Diff Utils library is an OpenSource library for performing the comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
Main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and it's nice design of diff module.
**This is originally a fork of java-diff-utils from Google Code Archive.**
## Main Features ##
* computing the difference between two texts.
* capable to hand more than plain ascci. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
* patch and unpatch the text with the given patch
* parsing the unified diff format
* producing human-readable differences
* inline difference construction
### Algoritms ###
This library implements Myer's diff algorithm. But it can easily replaced by any other which is better for handing your texts. I have plan to add implementation of some in future.
### Changelog ###
* Version 1.4
* switch to maven and removed other artifacts
* changed groupid to **com.github.java-diff-utils** due to different forks at github
* updated maven plugins
* JDK 1.8 compatibility
* support for inline merge
* restructured packages
* changed API
* Version 1.2
* JDK 1.5 compatibility
* Ant build script
* Generate output in unified diff format (thanks for Bill James)
### To Install ###
**This jar is not yet to get at maven central.**
Just add the code below to your maven dependencies:
```
<dependency>
<groupId>com.github.java-diff-utils</groupId>
<artifactId>diffutils</artifactId>
<version>1.2.1</version>
</dependency>
```