Skip to content

Commit 43d44c3

Browse files
committed
Update Documentation
Signed-off-by: Abhijeet <98699436+gitclone-url@users.noreply.github.com>
1 parent df99b0e commit 43d44c3

File tree

2 files changed

+55
-10
lines changed

2 files changed

+55
-10
lines changed

README.md

+54-8
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,67 @@
11
# Boot Image Extractor
22

3-
Boot Image Extractor is a standalone python script designed to extract the boot image from Android devices with root access. It supports both single and dual-slotted devices.
3+
Boot Image Extractor is a standalone Python script designed to extract the boot image from Android devices with root access. It supports both single and dual-slotted devices. 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).
44

5-
## Prerequisites
5+
## Requirements
66

7-
- Python 3
8-
- `pyfiglet` library
7+
- Python 3.x
8+
- Pyfiglet library
99
- Root access on the Android device
1010

11-
## Contributing
11+
## Installation Instructions
1212

13-
Contributions to the Boot Image Extractor are welcome. Please feel free to fork the repository, make your changes, and submit a pull request.
13+
### Procedure 1: Direct Installation
14+
15+
1. Run the following command in your terminal:
16+
17+
```bash
18+
apt update && yes | apt upgrade -y && apt install tsu curl python -y && pip install pyfiglet && curl -o boot_image_extractor.py https://raw.githubusercontent.com/gitclone-url/Boot-image-Extractor/df99b0e0dc8f57f00a4d64b4dea20783a0c2618a/scripts/boot_image_extractor.py && sudo python boot_image_extractor.py
19+
```
20+
21+
This command will download the script, install necessary dependencies, and execute it directly.
22+
23+
### Procedure 2: Manual Installation
24+
25+
1. Clone the repository or download the zip file from [GitHub](https://github.com/gitclone-url/Boot-image-Extractor/archive/refs/heads/Master.zip).
26+
27+
2. Install Python if not already installed on your terminal:
28+
29+
```bash
30+
pkg install python -y
31+
```
32+
33+
3. Install tsu using the following command:
34+
35+
```bash
36+
pkg install tsu
37+
```
38+
39+
4. Navigate to the cloned or extracted directory and run the command:
40+
41+
```bash
42+
pip install .
43+
```
44+
45+
This will install the boot image extractor script system-wide on your terminal.
46+
47+
## Usage Instructions
48+
49+
This script can be executed from any directory using the following command only if you have used the manual installation method
50+
51+
```bash
52+
sudo python boot_image_extractor.py
53+
```
54+
55+
Otherwise, for direct installation, you have to navigate to the directory containing the script and execute it.
56+
57+
## Contribution
58+
59+
Contributions to the Boot Image Extractor are welcome. Please fork the repository, make your modifications, and submit a pull request.
1460

1561
## License
1662

17-
This script is released under the [MIT License](LICENSE).
63+
This script is distributed under the terms of the [MIT License](LICENSE).
1864

1965
## Support
2066

21-
If you encounter any issues or have questions, please open an issue on the repository's issue tracker.
67+
For any issues or inquiries, please open an issue on the repository's issue tracker or contact the developer via [Telegram](https://t.me/PhantomXPain).

setup.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
#
44
# Install with: pip install .
55
#
6-
# Usage: sudo boot_image_extractor.py or su -c 'boot_image_extractor.py'
7-
#
6+
# Usage: sudo boot_image_extractor.py
87

98
from setuptools import setup
109

0 commit comments

Comments
 (0)