diff options
| author |  Runemoro | 2019-11-02 17:16:53 -0400 |
|---|---|---|
| committer |  modmuss50 | 2019-11-02 21:16:53 +0000 |
| commit | 2c7dbf2493bfa3c307575b4cef36cb4812619acb (patch) | |
| tree | 1069d5adae9d56f1be1199a77b09be22f623f1db /README.md | |
| parent | Merge branch 'pull/163' and bump version (diff) | |
| download | enigma-2c7dbf2493bfa3c307575b4cef36cb4812619acb.tar.gz enigma-2c7dbf2493bfa3c307575b4cef36cb4812619acb.tar.xz enigma-2c7dbf2493bfa3c307575b4cef36cb4812619acb.zip | |
Update readme (#170)
* Update readme
* Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..a671c379 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,26 @@ | |||
| 1 | # Enigma | ||
| 2 | |||
| 3 | A tool for deobfuscation of Java bytecode. Forked from <https://bitbucket.org/cuchaz/enigma>, copyright Jeff Martin. | ||
| 4 | |||
| 5 | ## License | ||
| 6 | |||
| 7 | Enigma is distributed under the [LGPL-3.0](LICENSE). | ||
| 8 | |||
| 9 | Enigma includes the following open-source libraries: | ||
| 10 | - A [modified version](https://github.com/FabricMC/procyon) of [Procyon](https://bitbucket.org/mstrobel/procyon) (Apache-2.0) | ||
| 11 | - [Guava](https://github.com/google/guava) (Apache-2.0) | ||
| 12 | - [SyntaxPane](https://github.com/Sciss/SyntaxPane) (Apache-2.0) | ||
| 13 | - [Darcula](https://github.com/bulenkov/Darcula) (Apache-2.0) | ||
| 14 | - [fuzzywuzzy](https://github.com/xdrop/fuzzywuzzy/) (GPL-3.0) | ||
| 15 | - [jopt-simple](https://github.com/jopt-simple/jopt-simple) (MIT) | ||
| 16 | - [ASM](https://asm.ow2.io/) (BSD-3-Clause) | ||
| 17 | |||
| 18 | ## Usage | ||
| 19 | |||
| 20 | ### Launching the GUI | ||
| 21 | |||
| 22 | `java -jar enigma.jar` | ||
| 23 | |||
| 24 | ### On the command line | ||
| 25 | |||
| 26 | `java -cp enigma.jar cuchaz.enigma.CommandMain` | ||