Update readme

rednaga · Nov 12, 2020 · 3577853 · 3577853
1 parent ec0b09c
commit 3577853
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ For more information on what this tool can be used for, check out:
 * [Detecting Pirated and Malicious Android Apps with APKiD](http://rednaga.io/2016/07/31/detecting_pirated_and_malicious_android_apps_with_apkid/)
 * [APKiD: PEiD for Android Apps](https://github.com/enovella/cve-bio-enovella/blob/master/slides/bheu18-enovella-APKID.pdf)
 
-# Installing
+## Installing
 
 ```bash
 
@@ -31,7 +31,7 @@ Finally, install APKiD:
 pip install apkid
 ```
 
-## Docker
+### Docker
 
 You can also run APKiD with [Docker](https://www.docker.com/community-edition)! Of course, this requires that you have git and Docker installed.
 
@@ -47,7 +47,7 @@ docker/apkid.sh ~/reverse/targets/android/example/example.apk
  |-> compiler : dx
 ```
 
-# Usage
+## Usage
 
 ```
 usage: apkid [-h] [-v] [-t TIMEOUT] [-r] [--scan-depth SCAN_DEPTH]
@@ -76,7 +76,7 @@ output:
   -o DIR, --output-dir DIR                   write individual results here (implies --json)
 ```
 
-# Submitting New Packers / Compilers / Obfuscators
+## Submitting New Packers / Compilers / Obfuscators
 
 If you come across an APK or DEX which APKiD does not recognize, please open a GitHub issue and tell us:
 
@@ -87,13 +87,13 @@ We are open to any type of concept you might have for "something interesting" to
 
 Pull requests are welcome. If you're submitting a new rule, be sure to include a file hash of the APK / DEX so we can check the rule.
 
-# License
+## License
 
 This tool is available under a dual license: a commercial one suitable for closed source projects and a GPL license that can be used in open source software.
 
 Depending on your needs, you must choose one of them and follow its policies. A detail of the policies and agreements for each license type are available in the [LICENSE.COMMERCIAL](LICENSE.COMMERCIAL) and [LICENSE.GPL](LICENSE.GPL) files.
 
-# Hacking
+## Hacking
 
 If you want to install the latest version in order to make changes, develop your own rules, and so on, simply clone this repository, compile the rules, and install the package in editable mode:
 
@@ -112,35 +112,19 @@ pip install -e .[dev,test] --user
 
 If you update any of the rules, be sure to run `prep-release.py` to recompile them.
 
-# For Maintainers
+## For Maintainers
 
 This section is for package maintainers.
 
-To update the PyPI package:
+Make sure the version has been updated in [apkid/__init__.py](apkid/__init__.py)
+
+Update the compiled rules, the readme, build the package and upload to PyPI:
 
 ```bash
-./prep-release.py readme
+./pre-release.py readme
 rm -f dist/*
 python setup.py sdist bdist_wheel
 twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
 ```
 
-Update the generated `README.rst` until Pandoc learns how to translate Markdown with images that are links into reStructuredText:
-```rst
-.. image:: https://travis-ci.org/rednaga/APKiD.svg?branch=master
-    :target: https://travis-ci.org/rednaga/APKiD
-
-.. image:: https://img.shields.io/pypi/v/apkid.svg
-    :target: https://pypi.python.org/pypi/apkid
-
-.. image:: https://img.shields.io/pypi/pyversions/apkid.svg
-    :target: https://pypi.python.org/pypi/apkid
-
-.. image:: https://img.shields.io/pypi/format/apkid.svg
-    :target: https://pypi.python.org/pypi/apkid
-
-.. image:: https://img.shields.io/pypi/l/apkid.svg
-    :target: https://pypi.python.org/pypi/apkid
-```
-
 For more information see [Packaging Projects](https://packaging.python.org/tutorials/packaging-projects/).
diff --git a/README.rst b/README.rst
@@ -23,34 +23,14 @@ For more information on what this tool can be used for, check out:
    Apps <https://github.com/enovella/cve-bio-enovella/blob/master/slides/bheu18-enovella-APKID.pdf>`__
 
 Installing
-==========
-
-Installation is unfortunately a bit involved until a `pull
-request <https://github.com/VirusTotal/yara/pull/1073>`__ is merged in a
-dependency. Here’s how you do it:
+----------
 
 .. code:: bash
 
-   git clone --recursive -b "v3.10.0" https://github.com/VirusTotal/yara-python.git /tmp/yara-python
-   cd /tmp/yara-python/yara 
-   curl https://patch-diff.githubusercontent.com/raw/VirusTotal/yara/pull/1073.patch | git am
-   cd ..
-   python setup.py build --enable-dex
-   python setup.py install
-
-Without this patch to Yara, the dexlib1 detection rule will fail as will
-any rule relying on string sizes.
 
-If this patch wasn’t needed, here’s how you’d install. First, install
-`yara-python <https://github.com/VirusTotal/yara-python>`__ with
-``--enable-dex`` to compile Yara’s DEX module:
-
-.. code:: bash
-
-   # Don't use this method, for now.
-   #pip install --upgrade wheel
-   #pip wheel --wheel-dir=/tmp/yara-python --build-option="build" --build-option="--enable-dex" git+https://github.com/VirusTotal/[email protected]
-   #pip install --no-index --find-links=/tmp/yara-python yara-python
+   pip install --upgrade wheel
+   pip wheel --wheel-dir=/tmp/yara-python --build-option="build" --build-option="--enable-dex" git+https://github.com/VirusTotal/[email protected]
+   pip install --no-index --find-links=/tmp/yara-python yara-python
 
 Finally, install APKiD:
 
@@ -59,7 +39,7 @@ Finally, install APKiD:
    pip install apkid
 
 Docker
-------
+~~~~~~
 
 You can also run APKiD with
 `Docker <https://www.docker.com/community-edition>`__! Of course, this
@@ -78,7 +58,7 @@ Here’s how to use Docker:
     |-> compiler : dx
 
 Usage
-=====
+-----
 
 ::
 
@@ -108,7 +88,7 @@ Usage
      -o DIR, --output-dir DIR                   write individual results here (implies --json)
 
 Submitting New Packers / Compilers / Obfuscators
-================================================
+------------------------------------------------
 
 If you come across an APK or DEX which APKiD does not recognize, please
 open a GitHub issue and tell us:
@@ -125,7 +105,7 @@ Pull requests are welcome. If you’re submitting a new rule, be sure to
 include a file hash of the APK / DEX so we can check the rule.
 
 License
-=======
+-------
 
 This tool is available under a dual license: a commercial one suitable
 for closed source projects and a GPL license that can be used in open
@@ -137,7 +117,7 @@ are available in the `LICENSE.COMMERCIAL <LICENSE.COMMERCIAL>`__ and
 `LICENSE.GPL <LICENSE.GPL>`__ files.
 
 Hacking
-=======
+-------
 
 If you want to install the latest version in order to make changes,
 develop your own rules, and so on, simply clone this repository, compile
@@ -163,39 +143,23 @@ If you update any of the rules, be sure to run ``prep-release.py`` to
 recompile them.
 
 For Maintainers
-===============
+---------------
 
 This section is for package maintainers.
 
-To update the PyPI package:
+Make sure the version has been updated in
+`apkid/init.py <apkid/__init__.py>`__
+
+Update the compiled rules, the readme, build the package and upload to
+PyPI:
 
 .. code:: bash
 
-   ./prep-release.py readme
+   ./pre-release.py readme
    rm -f dist/*
    python setup.py sdist bdist_wheel
    twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
 
-Update the generated ``README.rst`` until Pandoc learns how to translate
-Markdown with images that are links into reStructuredText:
-
-.. code:: rst
-
-   .. image:: https://travis-ci.org/rednaga/APKiD.svg?branch=master
-       :target: https://travis-ci.org/rednaga/APKiD
-
-   .. image:: https://img.shields.io/pypi/v/apkid.svg
-       :target: https://pypi.python.org/pypi/apkid
-
-   .. image:: https://img.shields.io/pypi/pyversions/apkid.svg
-       :target: https://pypi.python.org/pypi/apkid
-
-   .. image:: https://img.shields.io/pypi/format/apkid.svg
-       :target: https://pypi.python.org/pypi/apkid
-
-   .. image:: https://img.shields.io/pypi/l/apkid.svg
-       :target: https://pypi.python.org/pypi/apkid
-
 For more information see `Packaging
 Projects <https://packaging.python.org/tutorials/packaging-projects/>`__.