Skip to content

Commit c8ef3c5

Browse files
author
Andreas Dann
committed
add badge to README.md
1 parent 856f824 commit c8ef3c5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
![Maven Build](https://github.com/secure-software-engineering/sootdiff/actions/workflows/maven.yml/badge.svg)
2+
3+
14
# SootDiff - Bytecode Comparison Across Different Java Compilers
25

36
This repository hosts the SootDiff analysis tool. SootDiff allows the comparison of the Java ByteCode create by different Java compilers.
@@ -29,3 +32,12 @@ If you want to read the details on how SootDiff works, the published paper [Soot
2932

3033
## License
3134
SootDiff is licensed under the MIT license, see LICENSE file. This basically means that you are free to use the tool (even in commercial, closed-source projects).
35+
36+
37+
# Use SootDiff to compare Jars
38+
39+
The class `src/test/java/MainCompareArtifacts.java` can be used to compare multiple jars on the basis of class sha,tlshs and timestamps and produces a markdown report of that.
40+
41+
Invoke the main method with parameters `-inJars jar1,jar2,jar3 -fileFilter pathToFilterFile.txt`
42+
43+
The filter file can be used to specify classes of interest (e.g. classes fixed in a fixing commit). Make sure to specify the files as they would be located in the analyzed jar, e.g., in a commit the change might be related to `src/main/java/pack/a/b.java`, in the jar it would be referenced from the package onwards and in class format: `pack/a/b.class`.

0 commit comments

Comments
 (0)