nextcloud-android/README.md
Kerbalnut a1384419f7 Minor updates to README for Windows syntax for logcat instructions.
Modified 3 lines in README.md

Line 58 had:
`adb shell pidof -s 'com.nextcloud.client` (just one single-quote). Added a second single-quote to close the string and make it: `adb shell pidof -s 'com.nextcloud.client'`, otherwise the terminal will give you new lines waiting for the closing quote.

Line 59 & 60 use %HOMEPATH% environment var instead of %USERPROFILE%

- %HOMEPATH% will return `\Users\username`
- %USERPROFILE% will return `C:\Users\username`

Also added double-quotes around the entire path string in case username contains spaces, e.g. `C:\Users\user name`

For a PowerShell.exe terminal (what MS is starting to recommend over cmd.exe), the same lines can be used with a var reference of `$env:USERPROFILE` instead of `%USERPROFILE%`. I added in an extra hint line in the instructions to remind people of this.

Signed-off-by: Kerbalnut <Kerbalnut@users.noreply.github.com>
2022-10-21 22:24:38 -07:00

86 lines
5.5 KiB
Markdown

# [Nextcloud](https://nextcloud.com) Android app :iphone:
[![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)
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
alt="Download from Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.nextcloud.client)
[<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/)
**The Android client for [Nextcloud](https://nextcloud.com). Easily work with your data on your Nextcloud.**
![App screenshots](/doc/Nextcloud_Android_Screenshots.png "App screenshots")
## How to contribute :rocket:
If you want to [contribute](https://nextcloud.com/contribute/) to Nextcloud, you are very welcome:
* our forum at https://help.nextcloud.com
* for translations of the app on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android/)
* opening issues and PRs (including a corresponding issue)
## Contribution Guidelines & License :scroll:
[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>)
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.
Please review the [guidelines for contributing](https://github.com/nextcloud/android/blob/master/CONTRIBUTING.md) to this repository.
More information on how to contribute: <https://nextcloud.com/contribute/>
## Start contributing :hammer\_and\_wrench:
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).
### Getting debug info via logcat :mag:
#### With a linux computer:
* enable USB-Debugging in your smartphones developer settings and connect it via USB
* open command prompt/terminal
* enter `adb logcat --pid=$(adb shell pidof -s 'com.nextcloud.client') > logcatOutput.txt` to save the output to this file
**Note:** You must have [adb](https://developer.android.com/studio/releases/platform-tools.html) installed first!
#### On Windows:
* download and install [Minimal ADB and fastboot](https://forum.xda-developers.com/t/tool-minimal-adb-and-fastboot-2-9-18.2317790/#post-42407269)
* enable USB-Debugging in your smartphones developer settings and connect it via USB
* launch Minimal ADB and fastboot
* enter `adb shell pidof -s 'com.nextcloud.client'` and use the output as `<processID>` in the following command:
* `adb logcat --pid=<processID> > "%USERPROFILE%\Downloads\logcatOutput.txt"` (This will produce a `logcatOutput.txt` file in your downloads)
* if the processID is `18841`, an example command is: `adb logcat --pid=18841 > "%USERPROFILE%\Downloads\logcatOutput.txt"` (You might cancel the process after a while manually: it will not be exited automatically.)
* For a PowerShell terminal, replace `%USERPROFILE%` with `$env:USERPROFILE` in the commands above.
#### On a device (with root) :wrench:
* open terminal app *(can be enabled in developer options)*
* get root access via "su"
* enter `logcat -d --pid $(pidof -s com.nextcloud.client) -f /sdcard/logcatOutput.txt`
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)
**Note:** Your device needs to be rooted for this approach!
## Development version :hammer:
* [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:
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!
## Remarks :scroll:
Google Play and the Google Play logo are trademarks of Google Inc.