From f3f8584eea64439d0581505e4aba7eb730eff89f Mon Sep 17 00:00:00 2001 From: M M Arif Date: Tue, 21 May 2024 08:45:19 +0000 Subject: [PATCH] Update FAQ --- FAQ.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/FAQ.md b/FAQ.md index bdcad44..ec1ea6d 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,36 +1,34 @@ -## FAQ - -### What is GitNex? +## What is GitNex? GitNex is a free/paid, open-source Android client for Git repository management tool Forgejo and Gitea. [More here](https://codeberg.org/gitnex/GitNex#gitnex-android-client-for-gitea) -### Is GitNex free? +## Is GitNex free? Yes, it's free and open source. However, it is also available as a paid version on the [Play Store](https://play.google.com/store/apps/details?id=org.mian.gitnex.pro) to support development and infrastructure. -### How can I install it? +## How can I install it? You can install GitNex directly from [F-droid](https://f-droid.org/en/packages/org.mian.gitnex/). It is also available in the [Google Play store](https://play.google.com/store/apps/details?id=org.mian.gitnex.pro) as paid OR download the APK from the [releases](https://codeberg.org/gitnex/GitNex/releases) page and install it in your preferred Android device. -### I want to try the latest build(APK) from main branch. +## I want to try the latest build(APK) from main branch. Sure, [Download latest signed build from here](https://codeberg.org/gitnex/GitNex#user-content-downloads). -### What are the requirements? +## What are the requirements? So far none except you should have Android 6.0 OS at a minimum. Versions below this may not work. -### What Forgejo or Gitea version I need? +## What Forgejo or Gitea version I need? Please make sure that you are on latest Forgejo or Gitea(last major two stable releases, e.g 1.9 and 1.10) or later. Below this may not work as one would expect because of the newly added objects to the API at later versions. Please consider updating your Forgejo or Gitea server. Check the versions [compatibility page](https://codeberg.org/gitnex/GitNex/wiki/Compatibility) which lists all the supported versions with compatibility ratio. -### Will it work with other applications similar to Forgejo or Gitea like Gogs? +## Will it work with other applications similar to Forgejo or Gitea like Gogs? It's not tested and may not work due to differences in API endpoints. However, if the APIs are the same, it will definitely work. -### I have installed the APK from the release page, but installing or updating it from F-Droid or the Play Store is throwing an error. +## I have installed the APK from the release page, but installing or updating it from F-Droid or the Play Store is throwing an error. Please uninstall the existing app and then install it from your preferred store or location. This is because GitNex uses different keys for end builds, such as release, release CI tag, Play Store, and F-Droid. -### I want to help translate it to my language +## I want to help translate it to my language That's great to hear. We use [Crowdin](https://crowdin.com/project/gitnex) for translation. If your language is not listed, please request [here](https://codeberg.org/gitnex/GitNex/issues) to add it to the project. -### How can I help? +## How can I help? You can help in many ways, for example, using the app and reporting issues you encounter. Contributing via code and translations. If that are not your things you can help via [donations](https://gitnex.com/donate/) to get the development going and help in infrastructure costs. You can also help buying the [paid version](https://play.google.com/store/apps/details?id=org.mian.gitnex.pro) from play store. -### I have problem using GitNex +## I have problem using GitNex Please check the [Troubleshoot Guide](https://codeberg.org/gitnex/GitNex/wiki/Troubleshoot-Guide).