starting on some documentation

SecurityResearchStaff · Jun 14, 2017 · 1937120 · 1937120
1 parent 3ff9f3a
commit 1937120
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,24 @@
 Welcome to Androguard's documentation!
 ======================================
 
+Androguard is a full python tool to play with Android files.
+
+* DEX, ODEX
+* APK
+* Android's binary xml
+* Android resources
+* Disassemble DEX/ODEX bytecodes
+* Decompiler for DEX/ODEX files
+
+Documentation
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+
+
 API
 ===
 

diff --git a/docs/intro/gettingstarted.rst b/docs/intro/gettingstarted.rst
@@ -0,0 +1,23 @@
+Getting Started
+===============
+
+The easiest way to analyze APK files, is by using `androlyze.py`.
+It will start a iPython shell and has all modules loaded to get into action.
+
+Open a terminal and type `androlyze.py -s`.
+
+For analyzing and loading APK or DEX files, some wrapper functions exists.
+Use `AnalyzeAPK(filename)` or `AnalyzeDEX(filename)` to load a file and start analyzing:
+
+
+    a, d, dx = AnalyzeAPK("/home/user/some-app.apk")
+
+The three objects you get are `a` an `APK` object, `d` a `DalvikVMFormat` object and `dx` an `Analysis` object.
+
+Inside the `APK` object, you can find all information about the APK, like package name, permissions, the AndroidManifest.xml
+or its resources.
+
+The `DalvikVMFormat` corresponds to the DEX file found inside the APK file. You can get classes, methods or strings from
+the DEX file.
+
+The `Analysis` object contains special classes, which link information about the classes.dex.
diff --git a/docs/intro/index.rst b/docs/intro/index.rst
@@ -0,0 +1,7 @@
+Introduction
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   gettingstarted.rst