From 2c7dbf2493bfa3c307575b4cef36cb4812619acb Mon Sep 17 00:00:00 2001 From: Runemoro Date: Sat, 2 Nov 2019 17:16:53 -0400 Subject: Update readme (#170) * Update readme * Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 00000000..a671c379 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Enigma + +A tool for deobfuscation of Java bytecode. Forked from , copyright Jeff Martin. + +## License + +Enigma is distributed under the [LGPL-3.0](LICENSE). + +Enigma includes the following open-source libraries: + - A [modified version](https://github.com/FabricMC/procyon) of [Procyon](https://bitbucket.org/mstrobel/procyon) (Apache-2.0) + - [Guava](https://github.com/google/guava) (Apache-2.0) + - [SyntaxPane](https://github.com/Sciss/SyntaxPane) (Apache-2.0) + - [Darcula](https://github.com/bulenkov/Darcula) (Apache-2.0) + - [fuzzywuzzy](https://github.com/xdrop/fuzzywuzzy/) (GPL-3.0) + - [jopt-simple](https://github.com/jopt-simple/jopt-simple) (MIT) + - [ASM](https://asm.ow2.io/) (BSD-3-Clause) + +## Usage + +### Launching the GUI + +`java -jar enigma.jar` + +### On the command line + +`java -cp enigma.jar cuchaz.enigma.CommandMain` -- cgit v1.2.3