Updated readme documentation, fixed the help message, and moved the output-directory configuration to an option instead of a parameter

Author: dirkvranckaert

README.md

@@ -9,21 +9,31 @@ To accomplish the goal of a full decompile we use these tools:
 - Dex2Jar : Version 0.0.9.15
 - android-apktool : Version 1.5.2
 - JD-Core-Java : Version 1.2
+- Artistic Style (astyle) : Version 2.04
 
 
 Supported Platforms
 -------------------
-The tools has been built on Mac, but should work on all UNIX environments!
+The tools has been built on Mac, but most of it should work on all UNIX environments!
+Code formatting is not guaranteed to work on all platforms.
 
 Usage
 -----
 ```
-decompileAPK.sh <APK-file> [output-dir]
-Parameters:
- APK-file               The first parameter is required to be a valid APK file!
- Output Dir             The output directory is optional. If not set the
+usage: decompileAPK.sh [options] <APK-file>
+
+options:
+ -o,--output <dir>	The output directory is optional. If not set the
                          default will be used which is 'output' in the 
                          root of this tool directory.
+ -f,--format		Will format all Java files to be easier readable. 
+  			 However, use with CAUTION! This option might change 
+  			 line numbers!
+ -p,--project		Will generate a Gradle-based Android project for you
+ -h,--help		Prints this help message
+
+parameters:
+ APK-file               A valid APK file is required as input
 ```
 
 Contributions
@@ -36,5 +46,6 @@ This tool has been released under the Apache License 2.0.
 - Dex2Jar is licensed under the Apache License 2.0.
 - android-apktool is licensed under the Apache License 2.0
 - JD-Core-Java is licensed under the MIT License
+- Artistic Style is licensed under the GNU Lesser General Public License Version 3
 
 This project may be freely used for personal needs in a commercial or non-commercial environments.

decompileAPK.sh

@@ -7,29 +7,33 @@ function help
   echo "decompileAPK -- Decompiles an APK to have both the APK source and resources (XML
                 , 9-patches,...) decompiled."
   echo ""
-  echo "usage: decompileAPK.sh [options] <APK-file> [output-dir]"
+  echo "usage: decompileAPK.sh [options] <APK-file>"
   echo ""
   echo "options:"
+  echo " -o,--output <dir>	The output directory is optional. If not set the
+                         default will be used which is 'output' in the 
+                         root of this tool directory."
   echo " -f,--format		Will format all Java files to be easier readable. 
   			 However, use with CAUTION! This option might change 
   			 line numbers!"
   echo " -p,--project		Will generate a Gradle-based Android project for you"
   echo " -h,--help		Prints this help message"
   echo ""
   echo "parameters:"
-  echo " APK-file               The first parameter is required to be a valid APK file!"
-  echo " Output Dir             The output directory is optional. If not set the
-                         default will be used which is 'output' in the 
-                         root of this tool directory."
+  echo " APK-file               A valid APK file is required as input"
 }
 
 #Init values
 generateProject=false
 formatJava=false
+outputDir=
 
 # Check all of the possible options
 while [[ "$1" == -* ]]; do
     case $1 in
+        -o | --output )         shift
+        						outputDir=$1
+                                ;;
         -p | --project )        generateProject=true
                                 ;;
         -f | --format )         formatJava=true
@@ -43,7 +47,6 @@ done
 
 # Read parameters
 apkfile=$1
-outputDir=$2
 
 # Check a the minimum set of parameters is present. If not show help...
 if [ -z $apkfile ]