Skip to content

Commit fce097d

Browse files
committed
Even more tweaks
Signed-off-by: RaptaG <[email protected]>
1 parent e889ccb commit fce097d

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
</a>
55

66
<h1>OpenAndroidInstaller</h1>
7+
<p>Makes installing alternative Android distributions nice and easy!</p>
78

89
[![License](https://img.shields.io/github/license/openandroidinstaller-dev/openandroidinstaller?color=green)](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/LICENSE)
910
[![Release](https://img.shields.io/github/v/release/openandroidinstaller-dev/openandroidinstaller?include_prereleases)](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases)
@@ -12,9 +13,7 @@
1213
[![Twitter](https://img.shields.io/twitter/follow/oainstaller?style=social)](https://twitter.com/OAInstaller)
1314
[![Mastodon](https://img.shields.io/mastodon/follow/109341220262803943?domain=https%3A%2F%2Ffosstodon.org&style=social)](https://fosstodon.org/@openandroidinstaller)
1415

15-
<p>Makes installing alternative Android distributions nice and easy.</p>
16-
17-
<p align="center">
16+
<p>
1817
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>.
1918
<br><br>
2019
<strong>
@@ -27,17 +26,16 @@
2726
</p>
2827
</div>
2928

30-
> **Warning**: This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
29+
> **Warning:** This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
3130
32-
> **Note**: Unlocking the bootloader will erase all data on your device!
31+
> **Note:** Unlocking the bootloader will erase all data on your device!
3332
This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected.
3433
Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.
3534
If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
3635

37-
3836
## Usage
3937

40-
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.
38+
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.
4139

4240
1. Download the [.exe or appropriate executable file for your OS](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) from the releases or get the [official flatpak from flathub](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller). You might need to change permissions to run the executable.
4341
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
@@ -60,12 +58,10 @@ Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 L
6058
- or you can just search the web or the [xda-developers forum](https://forum.xda-developers.com) for an appropriate version for your device.
6159
3. Start the desktop app and follow the instructions.
6260

63-
6461
## Officially supported devices
6562

6663
Currently, the **we support 62 devices** by various vendors and working on adding more soon!
6764

68-
6965
Support for these devices is provided as best effort, but things might still go wrong.
7066
Help to improve the tool by reporting any issues you might face.
7167

@@ -96,6 +92,7 @@ Samsung | Galaxy Note 8 | greatlte | SM-N950F | tested
9692
Samsung | Galaxy Note 9 | [crownlte](https://wiki.lineageos.org/devices/crownlte) | | tested
9793
Samsung | Galaxy Note 10 | [d1](https://wiki.lineageos.org/devices/d1) | | tested
9894
Samsung | Galaxy Note 10+ | [d2s](https://wiki.lineageos.org/devices/d2s) | | tested
95+
9996
</details>
10097

10198
<details><summary><b>Google</b></summary>
@@ -113,6 +110,7 @@ Google | Pixel 4 XL | [coral](https://wiki.lineageos.org/devices/coral) | coral
113110
Google | Pixel 4a | [sunfish](https://wiki.lineageos.org/devices/sunfish) | sunfish | tested
114111
Google | Pixel 5 | [redfin](https://wiki.lineageos.org/devices/redfin) | redfin | tested
115112
Google | Pixel 5a | [barbet](https://wiki.lineageos.org/devices/barbet) | barbet | tested
113+
116114
</details>
117115

118116
<details><summary><b>Sony</b></summary>
@@ -127,6 +125,7 @@ Sony | Xperia XA2 | [pioneer](https://wiki.lineageos.org/devices/pioneer) | | te
127125
Sony | Xperia XZ2 | [akari](https://wiki.lineageos.org/devices/akari) | | tested
128126
Sony | Xperia XZ3 | [akatsuki](https://wiki.lineageos.org/devices/akatsuki) | | tested
129127
Sony | Xperia ZX | kagura | | planned
128+
130129
</details>
131130

132131
<details><summary><b>Fairphone</b></summary>
@@ -136,6 +135,7 @@ Vendor | Device Name | CodeName | Models | Status
136135
Fairphone | Fairphone 2 | [FP2](https://wiki.lineageos.org/devices/FP2) | | tested
137136
Fairphone | Fairphone 3 | [FP3](https://wiki.lineageos.org/devices/FP3) | | tested
138137
Fairphone | Fairphone 4 | [FP4](https://wiki.lineageos.org/devices/FP4) | | tested
138+
139139
</details>
140140

141141
<details><summary><b>Motorola</b></summary>
@@ -149,6 +149,7 @@ Motorola | moto g 5G plus / one 5G | [nairo](https://wiki.lineageos.org/devices/
149149
Motorola | moto g 5G / one 5G ace | [kiev](https://wiki.lineageos.org/devices/kiev) | | tested
150150
Motorola | edge | [racer](https://wiki.lineageos.org/devices/racer) | | tested
151151
Motorola | moto z | [griffin](https://wiki.lineageos.org/devices/griffin) | | tested
152+
152153
</details>
153154

154155
<details><summary><b>OnePlus</b></summary>
@@ -167,11 +168,11 @@ OnePlus | 7T Pro | [hotdog](https://wiki.lineageos.org/devices/hotdog) | | teste
167168
OnePlus | Nord | [avicii](https://wiki.lineageos.org/devices/avicii) | | tested
168169
OnePlus | Nord N200 | [dre](https://wiki.lineageos.org/devices/dre) | | tested
169170
OnePlus | 9 | lemonade | | under development
171+
170172
</details>
171173

172174
And more to come!
173175

174-
175176
## Contributing
176177

177178
All kinds of contributions are welcome. These include:
@@ -194,22 +195,19 @@ Please have a look before opening an issue or starting to contribute.
194195

195196
A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
196197

197-
198-
199198
## Tools
200199

201200
- 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
202201
- [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.
203202
- [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.
204203
- [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.
205204

206-
207205
## Acknowledgements
208206

209207
* Funded from September 2022 until February 2023 by ![logos of the "Bundesministerium für Bildung und Forschung", Prodotype Fund and OKFN-Deutschland](resources/pf_funding_logos.svg)
210208

211-
212209
## License
210+
213211
Original development by [Tobias Sterbak](https://tobiassterbak.com). Copyright (C) 2022-2023.
214212

215213
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

0 commit comments

Comments
 (0)