Skip to content

Commit 7eec486

Browse files
committed
Update install instruction for dev and Makefile
1 parent 9e28956 commit 7eec486

File tree

2 files changed

+16
-21
lines changed

2 files changed

+16
-21
lines changed

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
install:
2-
sudo apt update && sudo apt install android-tools-adb android-tools-fastboot
2+
curl -sSL https://install.python-poetry.org | python3 -
33
poetry install
4+
poetry run python scripts/download-tools.py
45

56
app:
67
poetry run python openandroidinstaller/openandroidinstaller.py
78

8-
build-app:
9+
build-app: install
910
poetry run pyinstaller openandroidinstaller/openandroidinstaller.py --noconsole --noconfirm --onefile --icon "/assets/favicon.ico" --add-data "openandroidinstaller/assets:assets" --add-binary "openandroidinstaller/bin/adb:bin" --add-binary "openandroidinstaller/bin/fastboot:bin" --add-binary "openandroidinstaller/bin/heimdall:bin"
1011

1112

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,31 +38,28 @@ Sony | Xperia Z3 | z3 | | under development
3838
Sony | Xperia ZX | kagura | | under development
3939
Fairphone | Fairphone 2 | FP2 | | under development
4040

41-
## Installation
41+
42+
## Usage
43+
4244
Currently, only linux is supported.
4345

4446
1. Download the AppImage, .exe or appropriate file for your OS.
45-
2. Install `adb` and `fastboot` by running `sudo apt install android-tools-adb android-tools-fastboot`
46-
3. OPTIONAL: Install `heimdall` for Samsung Devices:
47-
- download heimdall: https://androidfilehost.com/?w=files&flid=304516
48-
- install heimdall:
49-
- `$ unzip /path/to/heimdall_ubuntu.zip -d /tmp`
50-
- `$ cp /tmp/bin/heimdall* /usr/bin/`
51-
- `$ rm -rf /tmp/bin`
47+
2. Download the lineageOS image and the custom recovery image. A source for files can be found here: https://lineageosroms.com
48+
3. Start the desktop app and follow the instructions.
5249

53-
## Usage
54-
55-
Download the lineageOS image and the custom recovery image. A source for files can be found here: https://lineageosroms.com
56-
Start the desktop app and follow the instructions.
5750

5851
## Run OpenAndroidInstaller for development
5952

53+
Currently development is only supported on Ubunut Linux. MacOS should also work fine.
54+
6055
1. Clone the main branch of this repository
61-
2. Follow the steps 2. and 3. from 'Installation' above.
62-
3. Run `make poetry` and `make install` to setup poetry and the relevant requirements
63-
4. Run `make app` to start the desktop app from the source.
56+
2. Run `make install` to install poetry to manage python and install the requirend dependencies like adb, fastboot and heimdall.
57+
3. Run `make app` to start the desktop app from the source.
6458

65-
## Contribute your own installation configurations
59+
60+
## Contributing
61+
62+
### Contribute your own installation configurations
6663

6764
If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs).
6865

@@ -84,9 +81,6 @@ Every step in the config file corresponds to one view in the application. These
8481
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.
8582

8683

87-
## Contributing
88-
89-
9084
## Tools
9185

9286
- The [Android SDK Platform Tools](https://developer.android.com/studio/releases/platform-tools) (such as adb and fastboot) are [Apache](https://android.googlesource.com/platform/system/adb/+/refs/heads/master/NOTICE)-licensed universal Android utilities

0 commit comments

Comments
 (0)