Merge branch 'allaeddineomc-main' into dev

Author: tsterbak

.gitignore

@@ -26,6 +26,7 @@ wheels/
 heimdall/
 libusb-windows/
 openandroidinstaller/bin/
+.flatpak-builder
 
 # Log files
 pip-log.txt

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to the OpenAndroidInstaller project 
+
+💖 First of all: thank you for contributing to the OpenAndroidInstaller! Great that you are here!
+
+This document contains some resources which should help you in doing that.
+
+All kinds of contributions are welcome. These include:
+- Fix and improve texts in configs and in the application.
+- Test the tool for a supported device.
+- Create a config for a new device.
+- Test the application on your computer and/or device.
+- Contribute an application build for a new platform.
+- Add features and/or improve the code base.
+- Report bugs.
+
+## Code Of Conduct
+
+Everyone who contributes to the project must follow [our code of conduct](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CODE_OF_CONDUCT.md).
+If you notice any violations, please reach out to us via the ways described in the code of conduct.
+
+## How to Contribute
+
+### Report a bug
+
+Oops 😅 Thank you for catching a bug 🐛.
+Please report this bug to us:
+
+1. Ensure the bug was not already reported by searching through our [Issues](https://github.com/openandroidinstaller-dev/openandroidinstaller/issues).
+2. If you can't find a bug report for your bug, please [open a new one](https://github.com/openandroidinstaller-dev/openandroidinstaller/issues/new/choose). Please choose **Bug Report** here, add **a title and clear description** and fill in the blanks.
+
+For more information on how to write a good bug report, [check out the atom contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report)
+
+### The OpenAndroidInstaller "should to X" or is behaving weird / unintuitively / not doing what you want?
+
+If the OpenAndroidInstaller is behaving unintuitively, feels weird, doesn't do something you think it should or similar, please [open an issue](https://github.com/openandroidinstaller-dev/openandroidinstaller/issues/new/choose) if there doesn't exist one yet.
+
+We cannot guarantee that we can implement every feature you want, but we are always happy to discuss them and try to figure out how they might fit into the project.
+
+If you cannot figure out how to do something with the OpenAndroidInstaller you should be able to do, we consider [this a bug](#report-a-bug).
+
+### I don't understand the documentation 😕
+
+If the documentation is unintuitive, we consider [this a bug](#report-a-bug).
+
+If the documentation is missing something, we consider [this a bug](#report-a-bug).
+
+If the documentation does not make you happy, we consider [this a bug](#report-a-bug).
+
+### Write code / documentation to close issues
+
+If you want to write code or documentation, please take a look at our issues.
+We try to make them somewhat clear, but if you do not understand what an issue means, please ask us.
+We sometimes tag issues as "good first issue", these could be interesting if this is you first contribution.
+
+If you have an issue that you understand and want to work on, feel free to do so. If you leave a short message in the issue thread, we can make sure that we do not have multiple people working on the same issue.
+
+Once you have a fix, **open a new pull request**. We will try to review your pull request as quick as possible.
+
+To make sure we can merge it quickly, you can do a few things to help us:
+
+1. Please make sure that the PR description includes all information we need to review this pull request (for example the issue this fixes, how it works).
+2. Make sure that our linters, style checkers and tests pass. You can run them by running `make test`.
+3. Make sure that branch can be merged into the dev branch
+
+### Write code for new features 🚀
+
+If you want to write code for something that is not already [described in an issue](https://github.com/openandroidinstaller-dev/openandroidinstaller/issues), please open an issue first and communicate that you are working on it.
+Especially if it's more than a small bugfix for an obvious bug.
+We might have some opinions on whether / how your feature should be included into the OpenAndroidInstaller.
+
+If you do not open an issue first, we might have a lot of review comments that need to be addressed before we can merge your pull request or even have to close the PR entirely because we do not want to include the feature.
+
+Opening an issue first also allows other users to comment on it, often leading to a better result.
+
+### Write tests & documentation 🧪
+
+If you want to write tests & documentation for existing features / behavior, always feel free to do so and open a pull request.
+Here, we would also appreciate if you opened an issue first to avoid duplicate work.
+If you have any questions while doing to, please open an issue or write us an email.

README.md

@@ -5,6 +5,7 @@
   [![License](https://img.shields.io/github/license/openandroidinstaller-dev/openandroidinstaller?color=green&style=flat-square)](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/LICENSE)
   [![Release](https://img.shields.io/github/v/release/openandroidinstaller-dev/openandroidinstaller?include_prereleases&style=flat-square)](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases)
   [![Downloads](https://img.shields.io/github/downloads/openandroidinstaller-dev/openandroidinstaller/total?style=flat-square)](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases)
+  [![Flathub](https://img.shields.io/flathub/downloads/org.openandroidinstaller.OpenAndroidInstaller?label=flathub%20installs&style=flat-square)](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller)
   [![Twitter](https://img.shields.io/twitter/follow/oainstaller?style=social)](https://twitter.com/OAInstaller)
   [![Mastodon](https://img.shields.io/mastodon/follow/109341220262803943?domain=https%3A%2F%2Ffosstodon.org&style=social)](https://fosstodon.org/@openandroidinstaller)
   <p>Makes installing alternative Android distributions nice and easy.</p>
@@ -38,8 +39,8 @@ If you wish to backup the TA partition first, you can find tutorials related to
 
 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 AppImage, .exe or appropriate executable file for your OS. 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.
+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.
 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)
@@ -183,8 +184,13 @@ All kinds of contributions are welcome. These include:
 - Fix and improve texts in configs and in the application.
 - Test the tool for a supported device.
 - Create a config for a new device.
-- Test the application on your computer.
+- Test the application on your computer and/or device.
 - Contribute an application build for a new platform.
+- Add features and/or improve the code base.
+- Report bugs.
+
+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.
 
 A detailed list can be found [here](https://openandroidinstaller.org/#contribute).