nextcloud-android/README.md

75 lines
5.2 KiB
Markdown
Raw Normal View History

2017-10-20 02:40:56 +03:00
# [Nextcloud](https://nextcloud.com) Android app
[![Build Status](https://drone.nextcloud.com/api/badges/nextcloud/android/status.svg)](https://drone.nextcloud.com/nextcloud/android) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/80401cb343854343b4d94acbfb72d3ec)](https://www.codacy.com/app/Nextcloud/android?utm_source=github.com&utm_medium=referral&utm_content=nextcloud/android&utm_campaign=Badge_Grade) [![Releases](https://img.shields.io/github/release/nextcloud/android.svg)](https://github.com/nextcloud/android/releases/latest) [![irc](https://img.shields.io/badge/IRC-%23nextcloud--mobile%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-mobile)
2016-06-21 16:24:31 +03:00
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
2016-06-26 10:42:55 +03:00
alt="Download from Google Play"
2016-06-27 18:14:11 +03:00
height="80">](https://play.google.com/store/apps/details?id=com.nextcloud.client)
2016-06-25 20:05:20 +03:00
[<img src="https://f-droid.org/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.nextcloud.client/)
2016-06-21 16:24:31 +03:00
2017-10-20 02:40:56 +03:00
**The Android client for [Nextcloud](https://nextcloud.com). Easily work with your data on your Nextcloud.**
2017-10-20 02:40:56 +03:00
![App screenshots](/doc/Nextcloud_Android_Screenshots.png "App screenshots")
## How to contribute
If you want to [contribute](https://nextcloud.com/contribute/) to Nextcloud, you are very welcome:
2017-10-20 02:51:01 +03:00
- on our IRC channels [![irc](https://img.shields.io/badge/IRC-%23nextcloud%20on%20freenode-orange.svg)](https://webchat.freenode.net/?channels=nextcloud) and [![irc](https://img.shields.io/badge/IRC-%23nextcloud--mobile%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-mobile) on freenode
2016-06-07 02:22:13 +03:00
- our forum at https://help.nextcloud.com
2017-10-20 02:40:56 +03:00
- for translations of the app on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android/)
2017-10-20 02:46:49 +03:00
- opening issues and PRs (including a corresponding issue)
2017-10-20 02:40:56 +03:00
## Contribution Guidelines & License
[GPLv2](https://github.com/nextcloud/android/blob/master/LICENSE.txt). All contributions to this repository from June, 16 2016 on are considered to be licensed under the AGPLv3 or any later version.
Nextcloud doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend that every contributor adds following line to the header of a file, if they changed it substantially:
```
@copyright Copyright (c) <year>, <your name> (<your email address>)
```
2016-06-07 02:22:13 +03:00
Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.
2017-10-20 02:40:56 +03:00
Please review the [guidelines for contributing](https://github.com/nextcloud/android/blob/master/CONTRIBUTING.md) to this repository.
2016-05-24 18:33:32 +03:00
2017-10-20 02:40:56 +03:00
More information how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/)
2016-06-07 02:22:13 +03:00
## Start contributing
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%22starter+issue%22).
2016-06-07 02:22:13 +03:00
### Getting debug info via logcat
#### With a computer:
- connect the device via USB
2017-07-24 15:43:07 +03:00
- open command prompt/terminal
2018-11-20 02:50:48 +03:00
- enter `adb logcat | grep "$(adb shell ps | awk '/com.nextcloud.client/{print $2}')" > logcatOutput.txt` to save the output to this file
2017-07-24 15:43:07 +03:00
**Note:** You must have [adb](https://developer.android.com/studio/releases/platform-tools.html) installed first!
2017-07-24 15:43:07 +03:00
#### On a device (with root)
- open terminal app *(can be enabled in developer options)*
2017-07-24 15:43:07 +03:00
- get root access via "su"
- enter `logcat -d -f /sdcard/logcatOutput.txt`
- you will have to filter the output manually, as above approach is not working on device
2017-07-24 15:43:07 +03:00
2017-07-25 09:27:05 +03:00
or
- use [CatLog](https://play.google.com/store/apps/details?id=com.nolanlawson.logcat) or [aLogcat](https://play.google.com/store/apps/details?id=org.jtb.alogcat)
2017-07-24 15:43:07 +03:00
**Note:** Your device needs to be rooted for this approach!
2017-07-24 15:43:07 +03:00
## Development version
- [APK (direct download)](https://download.nextcloud.com/android/dev/latest.apk)
- [F-Droid](https://f-droid.org/en/packages/com.nextcloud.android.beta/)
2016-06-07 02:22:13 +03:00
2017-10-20 02:40:56 +03:00
## Support
2018-01-23 14:56:30 +03:00
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 or the [IRC-Channel](https://webchat.freenode.net/?channels=nextcloud-mobile). 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!
2016-09-05 11:00:53 +03:00
2017-10-20 02:40:56 +03:00
## Remarks
Google Play and the Google Play logo are trademarks of Google Inc.