Jade: The Java Decompiler

Jade is a Java decompiler that aims for high reliability through extensive testing.

Requirements

The only requirement is to have a copy of the Java JRE installed so that java can be run.

TODO: it is tested on Java version 19

Building the tool automatically downloads the other parts that are needed.

Building

To compile the project for use, simply run the following:

./gradlew build

Running Jade from command line

TODO

Generating HTML KDoc with Dokka

To generate KDoc, run the following:

./gradlew dokkaHtml

The generated html can be found in /build/dokka/html. To view the documentation, you can open index.html with your browser.

TODO: explain the following

./gradlew build installDist

./build/install/jade/bin/jade

$ ./gradlew run --args=--help

$ ./build/install/jade/bin/jade download-maven $(realpath ../jade2-maven-data/index/index) $(realpath ../jade2-maven-data/local-repo/) $(realpath ../jade2-maven-data/jar-lists/)

Developer Guide

For more details on Jade's codebase, refer to Developer Guide which can be found at docs/Developer Guide.md