You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Reordered device list to match order
- Linked LineageOS in description
- Made title for selfbuilding bigger (fixes#97)
- Removed trailing slashes
- Added link to website contribute section
Copy file name to clipboardExpand all lines: README.md
+68-66Lines changed: 68 additions & 66 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
15
15
<palign="center">
16
16
<br />
17
-
The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.
17
+
The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like <a href="https://lineageos.org">LineageOS</a>.
@@ -39,23 +39,23 @@ If you wish to backup the TA partition first, you can find tutorials related to
39
39
Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and MacOS are also supported but you might experience more issues. So far there is no support for ARM-based systems.
40
40
41
41
1. Download the AppImage, .exe or appropriate executable file for your OS. You might need to change permissions to run the executable.
42
-
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
42
+
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com) and other potentially drivers needed for your device.
43
43
2. Download the custom ROM image and the TWRP recovery image for your device and optionally some addons. A source for files can be found on the following websites:
44
44
- some custom ROMs:
45
-
-[LineageOS](https://wiki.lineageos.org/devices/)
45
+
-[LineageOS](https://wiki.lineageos.org/devices)
46
46
-[/e/OS](https://doc.e.foundation/devices)
47
-
-[LineageOS for microg](https://download.lineage.microg.org/)
- The recommended way to install MicroG is to use the zip file provided here: [https://github.com/FriendlyNeighborhoodShane/MinMicroG_releases/releases](https://github.com/FriendlyNeighborhoodShane/MinMicroG_releases/releases).
OnePlus | 7T Pro | [hotdog](https://wiki.lineageos.org/devices/hotdog) | | tested
161
+
OnePlus | Nord | [avicii](https://wiki.lineageos.org/devices/avicii) | | tested
162
+
OnePlus | Nord N200 | [dre](https://wiki.lineageos.org/devices/dre) | | tested
163
163
OnePlus | 9 | lemonade | | under development
164
164
</details>
165
165
@@ -184,6 +184,8 @@ All kinds of contributions are welcome. These include:
184
184
- Test the application on your computer.
185
185
- Contribute an application build for a new platform.
186
186
187
+
A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
188
+
187
189
### How to contribute your own installation configurations
188
190
189
191
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). The file should be named after the official `device code` of the device. Add the code output by `adb shell getprop | grep ro.product.device` (when the devices is connected to the computer) as well as the official device code to the `supported_device_codes` list in the config. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
@@ -223,7 +225,7 @@ Every step in the config file corresponds to one view in the application. These
223
225
224
226
You can also use the `requirements` field in the yaml, to specify `firmware` or `android` version requirements. The user will then be prompted if these requirements are satisfied.
225
227
226
-
###How to build the application for your platform
228
+
## How to build the application for your platform
227
229
228
230
The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.
229
231
@@ -239,7 +241,7 @@ Other phone vendors stops allowing to unlock the bootloader all together. There
239
241
## Tools
240
242
241
243
- 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
242
-
-[Heimdall](https://gitlab.com/BenjaminDobell/Heimdall/) is an [MIT](https://gitlab.com/BenjaminDobell/Heimdall/-/blob/master/LICENSE)-licensed replacement for the leaked ODIN tool to flash Samsung devices.
244
+
-[Heimdall](https://gitlab.com/BenjaminDobell/Heimdall) is an [MIT](https://gitlab.com/BenjaminDobell/Heimdall/-/blob/master/LICENSE)-licensed replacement for the leaked ODIN tool to flash Samsung devices.
243
245
-[libusb-1.0](https://github.com/libusb/libusb) is a [LGPL-2.1](https://github.com/libusb/libusb/blob/master/COPYING)-licensed library for USB device access from Linux, macOS, Windows and others.
244
246
-[copy-partitions-20220613-signed.zip](https://mirrorbits.lineageos.org/tools/copy-partitions-20220613-signed.zip) The copy-partitions script was created by LineageOS developer erfanoabdi and filipepferraz and released under LGPL. It is used when the partitions need to be copied before flashing.
245
247
@@ -256,4 +258,4 @@ This program is free software: you can redistribute it and/or modify it under th
256
258
257
259
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
258
260
259
-
You should have received a copy of the GNU General Public License along with this program. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
261
+
You should have received a copy of the GNU General Public License along with this program. If not, see [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
0 commit comments