chore: sync with microG unofficial installer

Signed-off-by: ale5000 <15793015+ale5000-git@users.noreply.github.com>

Author: ale5000-git

README.rst

@@ -8,6 +8,10 @@ Google sync add-on
 :Author: `ale5000 <https://github.com/ale5000-git>`_
 :License: `GPLv3.0 or later <./LICENSE.rst>`_
 
+.. image:: https://app.readthedocs.org/projects/google-sync-addon/badge/?version=latest
+   :alt: Documentation status
+   :target: https://google-sync-addon.readthedocs.io/en/latest/
+
 .. image:: https://codecov.io/gh/micro5k/google-sync-addon/branch/main/graph/badge.svg
    :alt: Coverage
    :target: https://codecov.io/gh/micro5k/google-sync-addon

build.sh

@@ -357,7 +357,8 @@ ZIP_SHA256="$(cut -d ' ' -f '1' -s 0< "${OUT_DIR:?}/${FILENAME:?}${FILENAME_EXT:
 
 ZIP_MD5=''
 if test "${FAST_BUILD:-false}" = 'false'; then
-  md5sum -b -- "${FILENAME:?}${FILENAME_EXT:?}" > "${OUT_DIR:?}/${FILENAME:?}${FILENAME_EXT:?}.md5" || ui_error 'Failed to compute the MD5 hash'
+  # Weak hash used only as a secondary verification (on legacy Android custom recoveries); no security impact
+  md5sum -b -- "${FILENAME:?}${FILENAME_EXT:?}" > "${OUT_DIR:?}/${FILENAME:?}${FILENAME_EXT:?}.md5" || ui_error 'Failed to compute the MD5 hash' # NOSONAR
   ZIP_MD5="$(cut -d ' ' -f '1' -s 0< "${OUT_DIR:?}/${FILENAME:?}${FILENAME_EXT:?}.md5")" || ui_error 'Failed to read the MD5 hash'
 fi
 

docs/BUILD.rst

@@ -24,15 +24,6 @@ Includes all components (proprietary and open-source):
 
    make buildota
 
-Open-source flavour
--------------------
-
-Includes only open-source components:
-
-.. code-block:: sh
-
-   make buildotaoss
-
 Test the build
 --------------
 
@@ -43,7 +34,7 @@ Emulates an Android recovery on the PC and runs the produced zip inside it:
    make test
 
 .. note::
-   Run ``buildota`` or ``buildotaoss`` first so that the zip exists in the ``output/`` folder.
+   Run ``buildota`` first so that the zip exists in the ``output/`` folder.
 
 
 `Gradle wrapper <https://docs.gradle.org/current/userguide/gradle_wrapper.html>`_
@@ -58,15 +49,6 @@ Includes all components (proprietary and open-source):
 
    ./gradlew buildOta
 
-Open-source flavour
--------------------
-
-Includes only open-source components:
-
-.. code-block:: sh
-
-   ./gradlew buildOtaOSS
-
 Test the build
 --------------
 
@@ -77,7 +59,7 @@ Emulates an Android recovery on the PC and runs the produced zip inside it:
    ./gradlew installTest
 
 .. note::
-   Run ``buildOta`` or ``buildOtaOSS`` first so that the zip exists in the ``output/`` folder.
+   Run ``buildOta`` first so that the zip exists in the ``output/`` folder.
 
 
 `VS Code <https://code.visualstudio.com/>`_
@@ -90,13 +72,6 @@ Includes all components (proprietary and open-source):
 
 Open the project in VS Code and run the ``buildOta`` task.
 
-Open-source flavour
--------------------
-
-Includes only open-source components:
-
-Open the project in VS Code and run the ``buildOtaOSS`` task.
-
 Test the build
 --------------
 
@@ -105,4 +80,4 @@ Emulates an Android recovery on the PC and runs the produced zip inside it:
 Open the project in VS Code and run the ``installTest`` task.
 
 .. note::
-   Run ``buildOta`` or ``buildOtaOSS`` first so that the zip exists in the ``output/`` folder.
+   Run ``buildOta`` first so that the zip exists in the ``output/`` folder.

docs/INSTRUCTIONS.rst

@@ -1,23 +1,42 @@
+############
+Instructions
+############
 ..
    SPDX-FileCopyrightText: (c) 2016 ale5000
    SPDX-License-Identifier: GPL-3.0-or-later
    SPDX-FileType: DOCUMENTATION
 
-============
-Instructions
-============
+You can `build it yourself <./BUILD.rst>`_ or download the prebuilt version.
 
-You can build it yourself or download the prebuilt version.
+.. contents:: Contents:
+   :local:
+   :depth: 2
+   :backlinks: none
 
 
-Build
------
+Prerequisites
+=============
 
-``./gradlew buildOta``
+- An Android device or emulator running **Android 4.4 or later**.
+- A custom recovery (see `Supported recoveries`_ below) or root access.
+
+Supported recoveries
+--------------------
+
+The following custom recoveries are supported:
+
+- `TWRP <https://twrp.me/>`_ (Team Win Recovery Project)
+- `OrangeFox Recovery <https://orangefox.download/>`_
+- `PitchBlack Recovery Project (PBRP) <https://pitchblackrecovery.com/>`_
+- `SKYHAWK Recovery Project (SHRP) <https://skyhawkrecovery.github.io/>`_
+- `LineageOS Recovery <https://github.com/LineageOS/android_bootable_recovery>`_
+- `ClockworkMod Recovery (CWM) <https://en.wikipedia.org/wiki/ClockworkMod>`_
+- `PhilZ Touch Recovery <https://xdaforums.com/t/2015-10-09-cwm-6-0-5-1-philz-touch-6-59-0-libtouch_gui-1-42.2201860/>`_
+- `Omni Recovery <https://github.com/omnirom/android_bootable_recovery>`_
 
 
 Download
---------
+========
 
 You can find the stable releases here:
 
@@ -26,3 +45,68 @@ You can find the stable releases here:
 Instead if you want to try the nightly builds you can find them here:
 
 - `Nightly - Full flavour <https://gitlab.com/micro5k/google-sync-addon/-/jobs/artifacts/main/browse/output?job=build-job>`_
+
+
+Installation
+============
+
+The methods below are **mutually exclusive**, choose **one** that matches your setup and follow only those steps.
+
+.. tip::
+   Regardless of which installation method you choose, you can pre-configure options before flashing by setting system properties on the device.
+   For example, to enable a longer live setup timeout:
+
+   .. code-block:: sh
+
+      adb shell "setprop zip.google-sync-addon.LIVE_SETUP_TIMEOUT 8"
+
+Via custom recovery
+-------------------
+
+1. Transfer the flashable zip to your device's internal storage or microSD card.
+2. Reboot into recovery (hold **Power + Volume Down** — exact key combination depends on your device).
+3. In TWRP, tap **Install**, navigate to the zip file and select it.
+4. Swipe to confirm the flash.
+5. Follow the on-screen prompts for the live setup (e.g., choose which optional apps to install).
+6. Once the flashing is complete, tap **Reboot** → **System**.
+
+Via ADB sideload
+----------------
+
+1. Reboot into recovery.
+2. In TWRP, tap **Advanced** → **ADB Sideload**, then swipe to start.
+3. On your PC, run:
+
+   .. code-block:: sh
+
+      adb sideload google-sync-addon-*.zip
+
+4. Follow the on-screen prompts for the live setup (e.g., choose which optional apps to install).
+5. Once the flashing is complete, reboot the device.
+
+Via ``zip-install.sh`` (ADB or terminal, root required, no recovery needed)
+---------------------------------------------------------------------------
+
+This method installs the zip from a running Android system using ``zip-install.sh``.
+
+1. Connect your device via USB with USB debugging enabled *(ADB only — skip if using a terminal app on the device)*.
+2. Open a shell: run ``adb shell`` on the PC or open a **terminal app** directly on the device.
+3. Transfer the flashable zip to your device's internal storage or microSD card.
+4. Run:
+
+   .. code-block:: sh
+
+      cd <path/to/my_folder/>
+      unzip ./google-sync-addon-*.zip zip-install.sh
+      sh ./zip-install.sh ./google-sync-addon-*.zip
+
+   The script will flash the zip directly on the running system, without using the recovery.
+
+5. Follow the on-screen prompts for the live setup (e.g., choose which optional apps to install).
+6. Once the flashing is complete, reboot the device.
+
+
+Uninstallation
+==============
+
+To uninstall re-flash the zip, enable live setup and select **Uninstall**.

docs/conf.py

@@ -7,6 +7,7 @@
 # For the full list of built-in configuration values, see the documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import os
+import subprocess
 
 # Functions
 def get_version():
@@ -19,13 +20,33 @@ def get_version():
                     return line.replace('version=', '').lstrip('v').strip()
     return '0.0.0-unknown'
 
+def get_revision():
+    # Try Read the Docs env vars first
+    git_rev = os.environ.get('READTHEDOCS_GIT_COMMIT_HASH')
+    git_id = os.environ.get('READTHEDOCS_GIT_IDENTIFIER')
+    if git_rev:
+        git_rev = git_rev[:8]
+        return f"{git_rev} ({git_id})" if git_id else git_rev
+
+    # Local Git fallback
+    try:
+        return subprocess.check_output(
+            ['git', 'rev-parse', '--short=8', 'HEAD'], stderr=subprocess.DEVNULL
+        ).decode('utf-8').strip()
+    except Exception:
+        return None
+
 # Project information
 project = 'Google sync add-on'
 author = 'ale5000'
 copyright = '2016-2019, 2021-%Y ale5000'
 release = get_version()
 version = release
 
+revision = get_revision()
+if revision:
+    copyright += f" | Revision: {revision}"
+
 # General configuration
 needs_sphinx = '8.1'
 extensions = [
@@ -49,9 +70,9 @@ def get_version():
 # Options for HTML output
 html_theme = 'sphinx_rtd_theme'
 html_context = {
-    "display_github": True,
-    "github_user": "micro5k",
-    "github_repo": "google-sync-addon",
-    "github_version": "main",
-    "conf_py_path": "/docs/"
+    'display_github': True,
+    'github_user': 'micro5k',
+    'github_repo': 'google-sync-addon',
+    'github_version': 'main',
+    'conf_py_path': '/docs/'
 }