Skip to content

Commit 6c18352

Browse files
authored
docs: Update installation Instructions
* remove automated one-liner installation method, doesn't works as expected! Signed-off-by: Abhijeet <98699436+gitclone-url@users.noreply.github.com>
1 parent 84a209e commit 6c18352

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
<div align="center">
22
<img src="https://github.com/gitclone-url/Boot-image-Extractor/assets/98699436/8fc2fc00-4dcd-4506-a161-7fec49a6ee34" loading="lazy" alt="Boot Image Extractor"/>
3-
<h2></h2>
43
</div>
54

6-
7-
<div style="display: flex; justify-content: center;">
8-
<div style="max-width: 800px;">
9-
<p>
10-
Boot Image Extractor is a standalone Python script designed to extract the boot image from Android devices with root access. It supports both <a href="https://source.android.com/devices/tech/ota/ab">A/B</a> and <a href="https://source.android.com/devices/bootloader/partitions">legacy partition</a> styles. This script was developed as part of an automated method for extracting boot images described in the <a href="https://gist.github.com/gitclone-url/a1f693b64d8f8701ec24477a2ccaab87#file-boot-image-extraction-guide-md">Boot Image Extraction Guide</a>.
11-
</p>
12-
</div>
13-
</div>
5+
Boot Image Extractor is a standalone Python script designed to extract the boot image from Android devices with root access. It supports both [A/B](https://source.android.com/devices/tech/ota/ab) and [legacy partition](https://source.android.com/devices/bootloader/partitions) styles. This script was developed as part of an automated method for extracting boot images described in the [Boot Image Extraction Guide](https://gist.github.com/gitclone-url/a1f693b64d8f8701ec24477a2ccaab87#file-boot-image-extraction-guide-md).
146

157
## Requirements
168

@@ -30,7 +22,7 @@
3022
```
3123

3224
3. **Check for PHH Superuser (if applicable):**
33-
If you are going to use this script on a [Phh-based GSI](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29) that ships with an inbuilt [superuser](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29#naming-conventions-that-some-gsi-buildermaintainer-uses), check if the PHH Superuser app is installed:
25+
If you are using a [Phh-based GSI](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29) that ships with an inbuilt [superuser](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29#naming-conventions-that-some-gsi-buildermaintainer-uses), check if the PHH Superuser app is installed:
3426
```bash
3527
(pm list packages | grep me.phh.superuser) && echo "App installed" || echo "Not found"
3628
```
@@ -41,27 +33,20 @@
4133
```bash
4234
su
4335
```
36+
37+
> **Important:** After granting superuser permissions, Return to the normal user environment by typing `exit` or pressing Ctrl+D. Then Proceed with the installation steps.
4438
45-
## Installation Instructions
46-
47-
#### Procedure 1: Direct Installation
48-
49-
1. **Run with One-Liner Commands:**
50-
Copy and paste the following command in termux and hit enter to start running the script:
51-
```bash
52-
apt update && apt upgrade -y; { command -v tsu && command -v curl && command -v python && command -v pip && python -c 'import pyfiglet' &>/dev/null; } || apt install -y tsu curl python; pip install pyfiglet; curl -o boot_image_extractor.py https://raw.githubusercontent.com/gitclone-url/Boot-image-Extractor/main/scripts/boot_image_extractor.py; clear; sudo python boot_image_extractor.py
53-
```
54-
> **Note:** It may take some time to run for the first time because the script will be downloaded along with the required tools. Please be patient.
55-
56-
#### Procedure 2: Manual Installation
39+
### Installation Instructions
5740

5841
1. **Clone or Download Source:**
5942
Clone the repository and navigate to the project directory:
6043
```bash
6144
git clone https://github.com/gitclone-url/Boot-image-Extractor.git
6245
cd Boot-image-Extractor
6346
```
64-
or download the source zip file from [GitHub](https://github.com/gitclone-url/Boot-image-Extractor/archive/refs/heads/master.zip), extract it, and navigate to the extracted directory.
47+
> **Note:** Install **Git** with `pkg install git`, if not already installed on the system.
48+
49+
Alternatively, download the source zip file from [GitHub](https://github.com/gitclone-url/Boot-image-Extractor/archive/refs/heads/master.zip), extract it, and navigate to the extracted directory.
6550

6651
2. **Install Dependencies:**
6752
Ensure Python and required packages are installed:
@@ -84,7 +69,7 @@ After installation, execute the script using the following command:
8469
sudo boot_image_extractor.py
8570
```
8671

87-
If you used the direct installation method and the script was downloaded to a different directory instead of Termux's `$HOME` directory, you may need to change to the directory where the script is located before running it.
72+
The extracted boot image will be saved in the same directory from which you run the script.
8873

8974
## Contribution
9075

0 commit comments

Comments
 (0)