Skip to content

Commit a02e5e8

Browse files
committed
Update readme
1 parent 5ada183 commit a02e5e8

2 files changed

Lines changed: 17 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,18 @@ Vendor | Device Name | CodeName | Models | Status
3232
---|---|---|---|---
3333
Samsung | Galaxy A3 2017 | a3y17lte | SM-A320FL | tested
3434
Samsung | Galaxy A5 2016 | a5xelte | SM-A510F | tested
35-
Samsung | Galaxy S7 | herolte | | planned
35+
Samsung | Galaxy S7 | herolte | | planned
36+
Samsung | Galaxy S9 | starlte | | under development
3637
Google | Pixel 3a | sargo | sargo | tested
38+
Google | Pixel 4a | sunfish | sunfish | planned
3739
Sony | Xperia Z | yuga | C6603 | tested
3840
Sony | Xperia Z3 | z3 | | under development
3941
Sony | Xperia ZX | kagura | | planned
4042
Fairphone | Fairphone 2 | FP2 | | under development
43+
Fairphone | Fairphone 3 | FP3 | | planned
4144
Xiaomi | Mi 9 Lite | pyxis | | planned
45+
Motorola | Moto G5 | cedric | | planned
46+
LG | G7 Thinq | judyln | | planned
4247

4348

4449
## Usage
@@ -52,7 +57,7 @@ Currently, only linux is supported.
5257

5358
## Run OpenAndroidInstaller for development
5459

55-
Currently development is only supported on Ubunut Linux. MacOS should also work fine.
60+
Currently development is only supported on Ubuntu Linux. MacOS should also work fine.
5661

5762
1. Clone the main branch of this repository
5863
2. Run `make install` to install poetry to manage python and install the requirend dependencies like adb, fastboot and heimdall.
@@ -77,11 +82,18 @@ Every step in the config file corresponds to one view in the application. These
7782
- `<image>`: The path of the image file.
7883
- `<recovery>`: The path of the recovery file.
7984
- `<inputtext>`: Text from the user input from `call_button_with_input` views.
80-
- `img`: Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
85+
- `img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
8186
- `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
8287

83-
After you created a config file, you can open a pull request to make the file available to other users. The file should be named after device name output by `adb shell dumpsys bluetooth_manager | grep 'name:' | cut -c9-` when the devices is connected to the computer. Please also add the device to the supported devices table above.
88+
The file should be named after device name output by `adb shell getprop | grep ro.poroduct.device` when the devices is connected to the computer. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
8489

90+
To test your config file with the executable without using the developer setup, place it in the same directory as the executable. There it will be detected by name.
91+
After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.
92+
93+
#### On unlocking the bootloader
94+
Some devices with require manual steps to unlock the bootloader. In general you will need to create an account at a vendor website and receive some code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola, Xiaomi* among others.
95+
96+
Other phone vendors stops allowing to unlock the bootloader all together. There is nothing to be done if you didn't unlock your device in time. These vendors include *Huawei and LG* among others. Support for these vendors will always be very limited.
8597

8698
## Tools
8799

openandroidinstaller/installer_config.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ def validate_config(config: str) -> bool:
116116
"content": str,
117117
schema.Optional("command"): Regex(r"^adb\s|^fastboot\s|^heimdall\s"),
118118
schema.Optional("allow_skip"): bool,
119+
schema.Optional("img"): str,
119120
}
120121

121122
config_schema = Schema({

0 commit comments

Comments
 (0)