From 25bd01adf4f1a3968d063b99458daa7dd6c55f8d Mon Sep 17 00:00:00 2001 From: Stephan Zeisberg Date: Tue, 23 Feb 2021 08:05:31 +0100 Subject: [PATCH] Add supported image formats to README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2cd2fd0..9ae2655 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ Extractor is a powerful Android firmware image extraction utility -# Installation -To run Extractor on your computer some preparation steps are required. Since Extractor is a python tool, a working python environment is required. Extractor depends on some git submodules, all of which can be initialized like so +## Supported formats -```bash -# Initialize git submodules -./scripts/init.sh +Extractor supports the following Android image formats: +``` +android sparse image, erofs, extfs, android signed images, android data image, android data image brotli, pac, zip, lz4, tar, tar md5, sin, ozip, app, kdz, bin, cpb, super ``` -If you wish to run Extractor without installing the necesarry requirements yourself, you may run it using docker. +# Installation +To run Extractor on your computer some preparation steps are necessary. Since Extractor is a python tool, a working python environment is required. ## Debian-based (Debian, Ubuntu) @@ -40,6 +40,16 @@ Now, install the python dependencies: ```bash pip3 install -r requirements.txt ``` + +Extractor depends on some git submodules, all of which can be initialized like so + +```bash +# Initialize git submodules +./scripts/init.sh +``` + +If you wish to run Extractor without installing the necesarry requirements yourself, you may run it using docker. + # Usage You can run Extractor on your machine by running: