Update README: FAQ/known issues section + misc

* Establish a Known Issues/FAQs section
* Move Support/Help section and expand it a little
* Give the logcat/logs section a proper header

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2024-01-15 11:44:11 -05:00 committed by Andy Scherzinger
parent 14c5bce228
commit c0074de7a2
1 changed files with 16 additions and 2 deletions

View File

@ -13,6 +13,16 @@ height="80">](https://f-droid.org/packages/com.nextcloud.client/)
![App screenshots](/doc/Nextcloud_Android_Screenshots.png "App screenshots")
## Getting help :rescue\_worker\_helmet:
Note: The section *Known Problems / FAQs* below may already document your situation.
If you need assistance or want to ask a question about the Android app, you are welcome to [ask for support](https://help.nextcloud.com/c/clients/android) in the [Nextcloud Help Forum](https://help.nextcloud.com). If you have found a probable bug or have an enhancement idea, feel free to [open a new Issue on GitHub](https://github.com/nextcloud/android/issues).
If you're not sure if something is a bug or a configuration matter (with your client, server, proxy, etc.), the [Nextcloud Help Forum](https://help.nextcloud.com) is probably the best place to start so that you can get feedback (you can always return here, after getting feedback there, to report a suspected bug).
Keep in mind, that this repository only manages the Android app. If you find bugs or have problems with the server/backend, you should use the Nextcloud Help Forum to ask for help or report the bug to the [Nextcloud server team](https://github.com/nextcloud/server)!
## How to contribute :rocket:
If you want to [contribute](https://nextcloud.com/contribute/) to the Nextcloud Android client app, there are many ways to help whether or not you are a coder:
@ -46,6 +56,8 @@ More information on how to contribute: <https://nextcloud.com/contribute/>
Make sure you read [SETUP.md](https://github.com/nextcloud/android/blob/master/SETUP.md) and [CONTRIBUTING.md](https://github.com/nextcloud/android/blob/master/CONTRIBUTING.md) before you start working on this project. But basically: fork this repository and contribute back using pull requests to the master branch.
Easy starting points are also reviewing [pull requests](https://github.com/nextcloud/android/pulls) and working on [starter issues](https://github.com/nextcloud/android/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
## Logs
### Getting debug info via logcat :mag:
#### With a linux computer:
@ -83,9 +95,11 @@ or
* [APK (direct download)](https://download.nextcloud.com/android/dev/latest.apk)
* [F-Droid](https://f-droid.org/en/packages/com.nextcloud.android.beta/)
## Support :rescue\_worker\_helmet:
## Known Problems and FAQs
If you need assistance or want to ask a question about the Android app, you are welcome to [ask for support](https://help.nextcloud.com/c/clients/android) in our Forums. If you have found a bug, feel free to [open a new Issue on GitHub](https://github.com/nextcloud/android/issues). Keep in mind, that this repository only manages the Android app. If you find bugs or have problems with the server/backend, you should ask the [Nextcloud server team](https://github.com/nextcloud/server) for help!
### Push notifications do not work on F-Droid editions
Push Notifications are not currently supported in the F-Droid builds due to dependencies on Google Play services.
## Remarks :scroll: