From d7f0a4ed28a1cbf752fa969e15fc1da589aa7e96 Mon Sep 17 00:00:00 2001 From: Skylot Date: Mon, 18 Mar 2013 21:04:23 +0400 Subject: [PATCH] Add readme and license files --- .gitignore | 17 +++++++++ NOTICE | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 40 ++++++++++++++++++++ 3 files changed, 163 insertions(+) create mode 100644 .gitignore create mode 100644 NOTICE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000000..8d1a8ac3248 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +.classpath +.project +.settings/ + +bin/ +target/ +build/ +idea/ +.gradle/ + +*.dex +*.jar +*.class +*.dump +*.log +*.cfg + diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000000..97d890911d6 --- /dev/null +++ b/NOTICE @@ -0,0 +1,106 @@ +The majority of jadx is written and copyrighted by me (Skylot) +and released under the Apache 2.0 license: + +******************************************************************************* +Copyright 2013 Skylot + +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. +******************************************************************************* + + +Various portions of the code including dx library are taken from +the Android Open Source Project, and are used in accordance with +the following license: + +******************************************************************************* +Copyright (C) 2007 The Android Open Source Project + +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. +******************************************************************************* + + +Other binary libraries used in 'jadx' +===================================== + +JCommander library (http://jcommander.org/) released under the following license: + +******************************************************************************* +Copyright 2012, Cedric Beust + +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. +******************************************************************************* + + +SLF4J source code and binaries are distributed under the following license: + +******************************************************************************* +Copyright (c) 2004-2011 QOS.ch + All rights reserved. + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +******************************************************************************* + + +Logback source code and binaries are dual-licensed under the EPL v1.0 and the LGPL 2.1, or more formally: + +******************************************************************************* +Logback: the reliable, generic, fast and flexible logging framework. +Copyright (C) 1999-2012, QOS.ch. All rights reserved. + +This program and the accompanying materials are dual-licensed under +either the terms of the Eclipse Public License v1.0 as published by +the Eclipse Foundation + + or (per the licensee's choosing) + +under the terms of the GNU Lesser General Public License version 2.1 +as published by the Free Software Foundation. +******************************************************************************* + diff --git a/README.md b/README.md new file mode 100644 index 00000000000..f700097d4f6 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +## About +**jadx** - Dex to Java decompiler + +### Build +jadx uses [gradle](http://www.gradle.org/) for build: + + git clone https://github.com/skylot/jadx.git + cd jadx + ./gradlew build + +(on windows, use `gradlew.bat` instead of `./gradlew`) + +Scripts for run jadx will be placed in `build/install/jadx/bin` +and also packed to `build/distributions/jadx-.zip` + +### Run +Run **jadx** on itself: + + cd build/install/jadx/ + bin/jadx -d out lib/jadx-*.jar + +### Usage +``` +jadx [options] (.dex, .apk, .jar or .class) +options: + -d, --output-dir - output directory + -j, --threads-count - processing threads count + -f, --fallback - make simple dump (using goto instead of 'if', 'for', etc) + --not-obfuscated - set this flag if code not obfuscated + --cfg - save methods control flow graph + --raw-cfg - save methods control flow graph (use raw instructions) + -v, --verbose - verbose output + -h, --help - print this help +Example: + jadx -d out classes.dex +``` + +*Licensed under the Apache 2.0 License* + +*Copyright 2013 by Skylot*