########################### microG unofficial installer ###########################

.. SPDX-FileCopyrightText: 2016 ale5000 SPDX-License-Identifier: GPL-3.0-or-later WITH LicenseRef-Archive-packaging-exception SPDX-FileType: DOCUMENTATION

:Author: ale5000 <https://github.com/ale5000-git>_

.. image:: https://app.readthedocs.org/projects/microg-unofficial-installer/badge/?version=latest&style=flat :alt: Documentation status :target: https://microg-unofficial-installer.readthedocs.io/en/latest/

.. image:: https://codecov.io/gh/micro5k/microg-unofficial-installer/branch/main/graph/badge.svg :alt: Code coverage on Codecov :target: https://codecov.io/gh/micro5k/microg-unofficial-installer

.. image:: https://api.reuse.software/badge/github.com/micro5k/microg-unofficial-installer :alt: REUSE compliance status :target: https://api.reuse.software/info/github.com/micro5k/microg-unofficial-installer

Description

microG unofficial installer is a flashable zip created by ale5000 for a simple installation of microG on Android from 2.2 to 16.

No in-depth Android knowledge needed, the installer takes care of the hard parts anyway. ✨

The installer automatically cleans up conflicting GApps and only the conflicting ones because it's polite like that. 🎩

This project is available on GitHub_, on GitLab_, as well as on XDA_.

.. _github: https://github.com/micro5k/microg-unofficial-installer

.. _gitlab: https://gitlab.com/micro5k/microg-unofficial-installer

.. _xda: https://xdaforums.com/t/3432360/

IMPORTANT: In addition to the normal installation as a pure flashable zip, there are plans for the future (but not in the short term) to also support the installation as a Magisk module.

Although you may find various references to Magisk in the code, support is NOT yet ready.

.. _readme-download:

Download & Installation

Grab the latest stable release or, if you like to live dangerously, the nightly build. The badges below show the current version and download statistics.

.. image:: https://img.shields.io/github/v/release/micro5k/microg-unofficial-installer.svg?cacheSeconds=3600 :alt: GitHub: latest release version :target: ./docs/INSTRUCTIONS.rst

.. image:: https://img.shields.io/github/downloads/micro5k/microg-unofficial-installer/total.svg?cacheSeconds=3600 :alt: GitHub: total OSS downloads :target: ./docs/INSTRUCTIONS.rst

.. image:: https://img.shields.io/github/downloads/micro5k/microg-unofficial-installer/latest/total.svg?cacheSeconds=3600 :alt: GitHub: downloads of the latest OSS release :target: ./docs/INSTRUCTIONS.rst

.. image:: https://img.shields.io/github/downloads/micro5k/microg-unofficial-installer/nightly/total.svg?cacheSeconds=600 :alt: GitHub: downloads of the latest OSS nightly :target: ./docs/INSTRUCTIONS.rst

Read the installation instructions before you flash <./docs/INSTRUCTIONS.rst>_ (ten minutes of reading beats one hour of re-flashing)

Code analysis

Yes, the code is actually linted. No, it wasn't always pretty. Yes, it's better now. 🔍

CI pipelines run on every push to keep the build healthy — the code-lint workflow checks style and correctness, while the nightly workflow validates a full automated build. In addition, SonarQube, Codacy, and CodeFactor provide continuous code quality analysis from multiple angles, because one linter is never enough.

.. image:: https://github.com/micro5k/microg-unofficial-installer/actions/workflows/code-lint.yml/badge.svg :alt: Code lint: CI status :target: https://github.com/micro5k/microg-unofficial-installer/actions/workflows/code-lint.yml

.. image:: https://github.com/micro5k/microg-unofficial-installer/actions/workflows/auto-nightly.yml/badge.svg :alt: Nightly build: CI status :target: https://github.com/micro5k/microg-unofficial-installer/actions/workflows/auto-nightly.yml

.. image:: https://sonarcloud.io/api/project_badges/measure?project=micro5k_microg-unofficial-installer&metric=reliability_rating :alt: SonarQube: reliability rating :target: https://sonarcloud.io/summary/new_code?id=micro5k_microg-unofficial-installer

.. image:: https://app.codacy.com/project/badge/Grade/e372a72b55f54bcf80966c8266e3e7fb :alt: Codacy: code quality grade :target: https://app.codacy.com/gh/micro5k/microg-unofficial-installer/dashboard

.. image:: https://www.codefactor.io/repository/github/micro5k/microg-unofficial-installer/badge :alt: CodeFactor: code quality :target: https://www.codefactor.io/repository/github/micro5k/microg-unofficial-installer

Contributing

If you want to improve the project, please review our contributing guidelines <./docs/CONTRIBUTING.rst>_.

We are grateful for all our contributors! 🎉 Seriously — every bug fix, improvement, or creative complaint has made this better.

Please check the contributors list <./docs/CONTRIBUTORS.md>_ for more details.

(Even fixing a typo counts. Probably. We'll review it very carefully either way.)

Donations

.. image:: https://img.shields.io/badge/Donate-FFF000?style=for-the-badge&logo=ko-fi&logoSize=auto&logoColor=black&cacheSeconds=21600 :alt: Support this project :target: ./docs/DONATE.rst

I maintain this project on my own in my spare time — the finite, precious kind that competes with sleep, meals eaten while staring at a terminal, and the occasional social obligation.

If it's saved you time, or frustration, please consider supporting its development!

| Wondering how? | Check out all the ways to fuel this project <./docs/DONATE.rst>_ — coffee, kind words, or cold hard crypto, it's all welcome. | (No pressure. But the coffee does make the bugs fix themselves slightly faster.)

Commercial use notice

Commercial use, commercial redistribution, and corporate deployment of this software are permitted. Thanks to the Archive Packaging Exception applied to the core installer files, you can safely bundle those components inside your own installable archives (such as recovery-flashable ZIPs, ROMs, or compressed packages) without the GPLv3 copyleft terms extending to your independent, non-derived modules.

License

This project is licensed under the GNU General Public License v3 or later (GPLv3+), with the Archive Packaging Exception to facilitate safe redistribution in compressed packages.

• Core license: The full text of the GPLv3 can be found in LICENSE.rst <./LICENSE.rst>__.
• Exception terms: The specific permissions for creating archives are detailed in LICENSE-EXCEPTION.rst <./LICENSE-EXCEPTION.rst>__.

What this means for you: You are free to bundle this software into your own archives (such as flashable ZIPs or tarballs) alongside proprietary or differently licensed modules, provided those modules are independent and not derived from this software.

Note for developers: The following SPDX identifier is used in the core installer files to enable the archive packaging exception:

.. code:: http

SPDX-License-Identifier: GPL-3.0-or-later WITH LicenseRef-Archive-packaging-exception

Other components within this repository remain subject to their respective upstream licenses.

Copyright

.. REUSE-IgnoreStart

© 2016-2019, 2021-2026 ale5000

.. REUSE-IgnoreEnd