Merge branch 'dev' into dev-flash-additional

Author: tsterbak

.github/FUNDING.yml

@@ -6,7 +6,7 @@ patreon: # Replace with a single Patreon username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
+liberapay: OpenAndroidInstaller
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
 lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

.github/workflows/build-release.yml

@@ -14,7 +14,7 @@ jobs:
       matrix:
         os: ['ubuntu-20.04', 'ubuntu-latest']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: 3.9
@@ -32,7 +32,7 @@ jobs:
       matrix:
         os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: 3.9
@@ -48,7 +48,7 @@ jobs:
     needs: ci
     runs-on: 'windows-latest'
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: 3.9
@@ -66,7 +66,7 @@ jobs:
       - build-windows
     runs-on: 'ubuntu-latest'
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Download artifact
       uses: actions/download-artifact@v3
     - name: Display structure of downloaded files

.github/workflows/manual-build.yml

@@ -13,7 +13,7 @@ jobs:
         os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest', 'windows-latest']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: 3.9

README.md

@@ -27,20 +27,21 @@
   </p>
 </div>
 
-> **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.
-
-> **Note**: Unlocking the bootloader will erase all data on your device!
-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.
-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.
-If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
+> [!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.
 
+> [!IMPORTANT]
+> Unlocking the bootloader will erase all data on your device!
+> 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.
+> 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.
+> If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
 
 ## Usage
 
 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.
 
 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.
-    - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
+    - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com) and other potentially drivers needed for your device.
 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:
     - some custom ROMs:
       - [LineageOS](https://wiki.lineageos.org/devices)
@@ -191,11 +192,11 @@ All kinds of contributions are welcome. These include:
 - Add features and/or improve the code base.
 - Report bugs.
 
-[How to contribute your own installation configurations](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/doc/how_to_contribute_your_own_installation_configurations.md)
+[How to contribute your own installation configurations](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/how_to_contribute_your_own_installation_configurations.md)
 
-[How to build the application for your platform](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/doc/building_the_application_for_your_platform.md)
+[How to build the application for your platform](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/building_the_application_for_your_platform.md)
 
-[On unlocking the bootloader](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/doc/unlocking_the_bootloader.md)
+[On unlocking the bootloader](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/unlocking_the_bootloader.md)
 
 More details on how to contribute can be found [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md).
 Please have a look before opening an issue or starting to contribute.

doc/unlocking_the_bootloader.md

@@ -0,0 +1,35 @@
+#### On unlocking the bootloader
+
+First of all, this tool will not help you bypass any vender locked bootloaders in non-official ways.
+
+Devices by *Samsung, Google, OnePlus, Fairphone* and others make it relatively easy to unlock the bootloader and get good support in the installer.
+
+For some devices, it is necessary to unlock the bootloader manually. You usually need to create an account on the manufacturer's website, wait for a certain time and obtain a code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola and Xiaomi* amongst others.
+
+Other phone manufacturers no longer allow you to unlock the bootloader. Nothing can be done if you have not unlocked your device in time. These manufacturers include *Huawei, Honor, LG and ASUS*. Support for these manufacturers will always be very limited.
+
+<details>
+    <summary>
+        <b>Here is a brief overview of the bootloader policies of some of the most popular brands (may be incomplete/inaccurate)</b>
+    </summary>
+
+| Brand | Flashing tool | Unlocking Method | Loss of guarantee\* | Supported models |
+|---|---|---|---|---|
+| Google | Fastboot | OEM/Flashing unlock | No | Pixel and Nexus |
+| Samsung | ODIN or Heimdall | Download mode | **Yes** | Galaxy S and A series<br>(Increasing complexity **on and after S10**) |
+| OnePlus | Fastboot | OEM/Flashing unlock | No | All |
+| Fairphone | Fastboot | [Code from manufacturer](https://support.fairphone.com/hc/en-us/articles/10492476238865-Manage-the-Bootloader)<br>(**Already unlocked until FP2**) | No | All |
+| Xiaomi | Fastboot | [Mi Unlock Tool](https://new.c.mi.com/global/post/101245) | **Yes** | Mi 4c, Redmi Note 3, Mi Note Pro, Redmi 3, Mi 4S, Mi 5 and all devices from 2016 onwards |
+| Motorola | Fastboot | [Code from manufacturer](https://en-us.support.motorola.com/app/standalone/bootloader/unlock-your-device-a) | **Yes** | Almost all **except** carrier specific models (e.g. Verizon, AT&T, Tracfone) and certain other models |
+| Sony | Fastboot | [Code from manufacturer](https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader) | **Yes** | All **except** XQ-CT62 (1Ⅳ US) & XQ-CQ62 (5Ⅳ US) |
+| Huawei | Fastboot | No official codes since 2017/2018<br>(**Unofficial methods available**) | **Yes** | Mate 9/9Pro, P10/P10Plus |
+| Honor | Fastboot | No official codes since 2017/2018<br>(**Unofficial methods available**) | **Yes** | Honor 8 |
+| LG | Fastboot | Impossible since December 2021 | **Yes** |  |
+| ASUS | Fastboot | Impossible since May 2023 (ASUS unlocking App) | **Yes** |  |
+
+**\*** In the EU you won't loose your standard 2 years of the warranty when you unlock your bootloader, flash your device or root it. ([source](https://forum.xda-developers.com/t/info-eu-rooting-and-flashing-dont-void-the-warranty.1998801/))
+
+</details>
+<br>
+
+You can find more information about the brands and their bootloader policies [here](https://wikilibriste.fr/fr/tutoriels-android/bootloader-unlock) (in French).

…ing_the_application_for_your_platform.md …ing_the_application_for_your_platform.mddoc/building_the_application_for_your_platform.md renamed to docs/building_the_application_for_your_platform.md doc/building_the_application_for_your_platform.md renamed to docs/building_the_application_for_your_platform.md

@@ -5,6 +5,7 @@ metadata:
   device_code: a5y17lte
   supported_device_codes:
     - a5y17lte
+    - a5y17ltecan
 steps:
   unlock_bootloader:
   boot_recovery:

…_your_own_installation_configurations.md …_your_own_installation_configurations.mddoc/how_to_contribute_your_own_installation_configurations.md renamed to docs/how_to_contribute_your_own_installation_configurations.md doc/how_to_contribute_your_own_installation_configurations.md renamed to docs/how_to_contribute_your_own_installation_configurations.md

@@ -276,7 +276,7 @@ def search_devices_clicked(self, e):
                     f"Device with code '{device_code}' is not supported yet."
                 )
                 # add request support for device button
-                request_url = f"https://github.com/openandroidinstaller-dev/openandroidinstaller/issues/new?labels=device&template=device-support-request.yaml&title=Add support for {device_code}"
+                request_url = f"https://github.com/openandroidinstaller-dev/openandroidinstaller/issues/new?labels=device&template=device-support-request.yaml&title=Add support for `{device_code}`"
                 self.device_request_row.controls.append(
                     ElevatedButton(
                         "Request support for this device",