Update readme (FabricMC#170)

* Update readme

* Update README.md

README.md

@@ -0,0 +1,26 @@
+# Enigma
+
+A tool for deobfuscation of Java bytecode. Forked from <https://bitbucket.org/cuchaz/enigma>, 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`

build.gradle

@@ -31,18 +31,6 @@ if (ENV.BUILD_NUMBER) {
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
-// Custom source layout
-sourceSets {
-    main {
-        java { srcDir 'src/main/java' }
-        resources { srcDir 'conf' }
-    }
-    test {
-        java { srcDir 'src/test/java' }
-        resources { srcDir 'test' }
-    }
-}
-
 task generateSources(type: Copy) {
     from sourceSets.main.java
     into generatedSourcesDir
@@ -121,7 +109,7 @@ file('src/test/java/cuchaz/enigma/inputs').listFiles().each { theFile ->
             main 'proguard.ProGuard'
             classpath configurations.proGuard
 
-            args '@proguard-test.conf', '-injars', file('build/test-inputs/' +
+            args '@src/test/resources/proguard-test.conf', '-injars', file('build/test-inputs/' +
                     "${theFile.name}.jar"), '-outjars', file('build/test-obf/' +
                     "${theFile.name}.jar")
         }
@@ -161,11 +149,8 @@ jar.manifest.attributes 'Main-Class': 'cuchaz.enigma.Main'
 // Make the "fat" application jar. This is useful to just throw in a classpath
 // for tests, though it includes some slightly useless stuff.
 shadowJar {
-    append 'license.LGPL3.txt'
-    append 'license.APL2.txt'
-    append 'readme.txt'
-
-    exclude 'META-INF/maven/**'
+    append 'LICENSE'
+    append 'README.md'
 }
 
 // Create a library jar, containing only the deobfuscation code, for use at

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Fri May 10 01:49:02 PDT 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip

gradlew

@@ -1,4 +1,20 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 
 ##############################################################################
 ##
@@ -28,16 +44,16 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
 
-warn ( ) {
+warn () {
     echo "$*"
 }
 
-die ( ) {
+die () {
     echo
     echo "$*"
     echo
@@ -154,11 +170,19 @@ if $cygwin ; then
     esac
 fi
 
-# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
-function splitJvmOpts() {
-    JVM_OPTS=("$@")
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
 }
-eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
-JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+APP_ARGS=$(save "$@")
 
-exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      http://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
@@ -14,7 +30,7 @@ set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome
@@ -49,7 +65,6 @@ goto fail
 @rem Get command-line arguments, handling Windows variants
 
 if not "%OS%" == "Windows_NT" goto win9xME_args
-if "%@eval[2+2]" == "4" goto 4NT_args
 
 :win9xME_args
 @rem Slurp the command line arguments.
@@ -60,11 +75,6 @@ set _SKIP=2
 if "x%~1" == "x" goto execute
 
 set CMD_LINE_ARGS=%*
-goto execute
-
-:4NT_args
-@rem Get arguments from the 4NT Shell from JP Software
-set CMD_LINE_ARGS=%$
 
 :execute
 @rem Setup the command line