forked from x0b/rcx
-
-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Update readme, templates, contribution guidelines, changelog
- Loading branch information
Showing
5 changed files
with
101 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Contributing to RCX | ||
|
||
We welcome any contribution to RCX, and there are multiple ways to contribute: | ||
|
||
- [Reporting a bug](#reporting-a-bug) | ||
- [Localize RCX into your language](#localize-rcx) | ||
- [Submitting a pull request](#submitting-a-pr) | ||
- [Requesting a new features](#requesting-a-new-feature) | ||
|
||
## Reporting a bug | ||
No one likes it if something goes wrong. However, before submitting a bug report, please make sure to check the following links: | ||
|
||
- [RCX documentation](https://x0b.github.io/docs/) | ||
- [search existing issues](https://github.com/x0b/rcx/issues?q=is%3Aissue) | ||
- [rclone documentation](https://rclone.org/) | ||
- [rclone forum](https://forum.rclone.org/) | ||
|
||
A lot of problems are errors in `rclone.conf`. If you have [Termux](https://github.com/termux/termux-app) installed, you can install rclone with `pkg install rclone`. Then, export your config from RCX and select Termux as target. You can then try to check if the error also occurs in Termux. You can also export and transfer your config to a desktop PC and test it there. | ||
|
||
If you experience the same issue on your PC or in Termux, you can use the rclone forum to post your problem. If you are really sure that you have discovered an issue in rclone itself, you can also open an issue in the rclone repository. | ||
|
||
When filing a new bug report, answer all the questions in the template. This includes: | ||
- App version (e.g. `v1.11.4`) | ||
- Exact Android version (e.g. `8.1.0`) | ||
- Your device model and manufacturer | ||
- An exact list of steps that leads to your issue. Please also enable local logging in Settings > Logging > Log rclone errors. | ||
- Paste or attach your rclone log (located in `Android/data/io.github.x0b.rcx/files/logs/log.txt`). Make sure to remove any confidential information such as passwords, tokens or authorization info. | ||
- If your issue happens when using a remote, please also add a redacted version of your configuration file (passwords and tokens removed). | ||
- We may also ask you to test your config file on another device. If you haven't done that yet, now may be a good time to try. | ||
|
||
## Localize RCX | ||
We are using [Crowdin](https://crowdin.com/project/rcx) to translate and localize RCX into different languages. See also [#77](https://github.com/x0b/rcx/issues/77). | ||
|
||
|
||
## Submitting a PR | ||
We're currently establishing new processes for contributing on GitHub. In the meantime, here are a few tips on getting your PR merged: | ||
|
||
1. Keep your PR small. Small PRs are easier to review, easier to test and as a result can be merged quickly. If this is your first PR to RCX, keep it very small. | ||
2. Keep your PR focussed. Your PR should have a single, specific purpose. If you discover something else you'd like to improve while working on your PR, only include it if there's a direct link to the purpose of the PR. | ||
3. Use the style of the existing code base. Use idiomatic code whenever possible. If you have performance concerns, use the profiler to test your assumptions. | ||
4. Rebase your branch before creating your PR. | ||
|
||
See [dev setup](https://x0b.github.io/dev/) to get started. | ||
|
||
## Requesting a new feature | ||
|
||
We also discuss new features on GitHub. You can browse the issue for existing feature requests and join the discussion. Note that commenting generally notifies all participants of your comment. Please avoid '+1', 'me to' or similar comments and use :+1: [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) instead. | ||
|
||
When opening a new feature request, **answer all questions in the template**. This includes: | ||
- Searching for existing issues and discussions that already cover your request. We may close your request without comment if you fail to do this. | ||
- For anything related to data transfer or accessing files on your cloud storage, please first check if your idea works in rclone. If it does not work there, it will probably also not work in RCX. | ||
- Asking yourself what you can do to create this feature. | ||
- The version of RCX you are using. | ||
|
||
You will also be asked two free-form questions: | ||
> #### What problem are you trying to solve? | ||
Describe what you are trying to achieve. This may include a series of steps if you are using rclone as part of a larger workflow, or may just be a single action. **Do not describe possible solutions.** Keep your ideas for the next question. | ||
|
||
You can describe this as a problem ("I cannot find a file"), or as a goal you want to achieve ("I would like to stream a video on my TV"). | ||
|
||
> #### What should RCX be able to do differently to help with this problem? | ||
Describe how you would solve your problem. This may include additional buttons, options, menus, dialogs, etc. | ||
|
||
This two-step approach allows us to to design general solutions, that work not just for your specific situation, but for the broader RCX user base. It also makes it easier for other community to join the discussion and suggest different solutions. | ||
|
||
Please keep in mind that RCX and rclone are developed by volunteers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,22 @@ | ||
# RCX - Rclone for Android | ||
[![license: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/x0b/rcx/blob/master/LICENSE) [![Github Releases](https://img.shields.io/github/downloads/x0b/rcx/total.svg)](https://github.com/x0b/rcx/releases) [![GitHub release](https://img.shields.io/github/v/release/x0b/rcx?include_prereleases)](https://github.com/x0b/rcx/releases/latest) [![Google Play Pre-Registration](https://img.shields.io/badge/Google_Play-Pre%E2%80%93Registration-brightgreen)](https://groups.google.com/forum/#!forum/rcx-alpha/join) | ||
[![license: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/x0b/rcx/blob/master/LICENSE) [![Github Releases](https://img.shields.io/github/downloads/x0b/rcx/total.svg)](https://github.com/x0b/rcx/releases) [![GitHub release](https://img.shields.io/github/v/release/x0b/rcx?include_prereleases)](https://github.com/x0b/rcx/releases/latest) [![Google Play](https://img.shields.io/badge/Google_Play-stable-brightgreen)](https://play.google.com/store/apps/details?id=io.github.x0b.rcx) [![F-Droid](https://img.shields.io/badge/F%E2%80%93Droid-stable-blue)](https://f-droid.org/packages/io.github.x0b.rcx) | ||
|
||
A cloud file manager, powered by rclone. | ||
|
||
🎉 We have rebranded to **RCX - Rclone for Android**. [Read more about the changes on the new website](https://x0b.github.io/posts/upcoming-changes-202001/). | ||
|
||
Features | ||
-------- | ||
|
||
Cloud Access | 256 Bit Encryption<sup>[1](https://rclone.org/crypt/#file-encryption)</sup> | Integrated Experience | ||
:-----:|:--------------:|:-----------: | ||
<img src="https://github.com/x0b/rcx/blob/master/docs/cloud-computing.png?raw=true" alt="Cloud Access" width="192" /> | <img src="https://github.com/x0b/rcx/blob/master/docs/locked-padlock.png?raw=true" alt="256 Bit End-to-End Encryption" width="144" /> | <img src="https://github.com/x0b/rcx/blob/master/docs/smartphone.png?raw=true" alt="Integrated Experience" width="176"/> | ||
<img src="https://github.com/x0b/rcx/blob/master/docs/cloud-computing.png?raw=true" alt="Cloud Access" width="144" /> | <img src="https://github.com/x0b/rcx/blob/master/docs/locked-padlock.png?raw=true" alt="256 Bit End-to-End Encryption" width="108" /> | <img src="https://github.com/x0b/rcx/blob/master/docs/smartphone.png?raw=true" alt="Integrated Experience" width="132"/> | ||
Use your cloud storage like a local folder. | Keep your files private on any cloud provider with crypt remotes. | Don't give up features or comfort just because it runs on a phone. | ||
|
||
- **File Management** (list, view, download, upload, move, rename, delete files and folders) | ||
- **Streaming** (Stream media files, serve files and directories over FTP, HTTP, WebDAV or DLNA) | ||
- **Integration** (Access local storage devices and share files with the application to store them on a remote) | ||
- **Many cloud storage providers** (all via rclone config import, some without) | ||
- **Material Design** (Dark theme, custom primary and accent colors) | ||
- **All architectures** (runs on ARM, ARM64, x86 and x64 devices, Android 7+ / 5+) | ||
- **All architectures** (runs on ARM, ARM64, x86 and x64 devices, Android 7+) | ||
- **Storage Access Framework (SAF)** ([see docs](https://x0b.github.io/docs/#adding-local-storage-saf)) for SD card and USB device access. | ||
|
||
Screenshots | ||
|
@@ -29,7 +27,7 @@ Manage Storage|Upload Files|Explore Files|Manage Files | |
|
||
Installation | ||
------------ | ||
Grab the [latest version](https://github.com/x0b/rcx/releases/latest) of the signed APK and install it on your phone. You can also [register for the closed Google Play testing group](https://groups.google.com/forum/#!forum/rcx-alpha/join), the [Google Play Beta](https://play.google.com/apps/testing/io.github.x0b.rcx), or in the near future, F-Droid. | ||
Grab the [latest version](https://github.com/x0b/rcx/releases/latest) of the signed APK and install it on your phone. You can also [register for the closed Google Play testing group](https://groups.google.com/forum/#!forum/rcx-alpha/join), the [Google Play Beta](https://play.google.com/apps/testing/io.github.x0b.rcx), or on [F-Droid](https://f-droid.org/packages/io.github.x0b.rcx). | ||
|
||
| CPU architecture | Where to find | APK identifier | | ||
|:---|:--|:---:| | ||
|
@@ -38,7 +36,7 @@ Grab the [latest version](https://github.com/x0b/rcx/releases/latest) of the sig | |
|Intel/AMD 32 Bit | some TV boxes and tablets | ```x86``` | | ||
|Intel/AMD 64 Bit | some emulators | ```x86_64``` | | ||
|
||
If you don't know which version to pick use ```rcx-<version>-universal-release.apk```. Most devices run ARM 64 Bit, and 64 Bit devices often can also run the respective 32 bit version at lower performance. The app runs on any CTS phone, tablet or TV with Android 5 or newer, but is only tested on Android 7 and newer. | ||
If you don't know which version to pick use ```rcx-<version>-universal-release.apk```. Most devices run ARM 64 Bit, and 64 Bit devices often can also run the respective 32 bit version at lower performance. The app runs on any phone, tablet or TV with Android 7 or newer, as long as you have a touchscreen or mouse. | ||
|
||
Usage | ||
------------ | ||
|
@@ -50,28 +48,21 @@ Known Issues | |
|
||
Contributing | ||
------------ | ||
This app is developed by and for its community. Any contribution to improve the app is welcome, and there are multiple to contribute: | ||
- Enable crash reporting in ```Settings > Logging > Send anonymous crash reports```. | ||
- Reporting bugs using the [issue tracker](https://github.com/x0b/rcx/issues). | ||
- Proposing and voting (👍 👎) on [new features](https://github.com/x0b/rcx/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement+sort%3Areactions-%2B1-desc) and ideas on the [issue tracker](https://github.com/x0b/rcx/issues). | ||
- Translating the app into a new language. Please [open an issue](https://github.com/x0b/rcx/issues/new) or sent an email to [[email protected]](mailto:[email protected]) if you are interested. | ||
- Implementing features and fixing bugs. See the list of [available](https://github.com/x0b/rcx/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [easier](https://github.com/x0b/rcx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) issues. Please comment on the issue if you want to take over. To get started with development, see [Getting Started](https://x0b.github.io/dev/). | ||
- Not all enhancements must be new features. If you find yourself wanting to do something with the app but you are unsure how to do it, or you think it is needlessly complicated or might not be possible, then just ask on the [issue tracker](https://github.com/x0b/rcx/issues), which may spark a new feature/enhancement request. | ||
- You might also find help from other members of the larger rclone community on the [rclone forum](https://forum.rclone.org/) or the [subreddit](https://www.reddit.com/r/rclone/). | ||
See [CONTRIBUTING](./CONTRIBUTING.md) | ||
|
||
License | ||
----------------- | ||
### About this app | ||
This app is released under the terms of the [GPLv3 license](https://github.com/x0b/rcx/blob/master/LICENSE). Community contributions are licensed under the MIT license, and [CLA Assistant](https://cla-assistant.io/) will ask you to confirm [a CLA stating that](https://gist.githubusercontent.com/x0b/889f037d76706fc9e3ab8ee1c047841b/raw/67c028b19e33111428904558cfda0c01039d1574/rcloneExplorer-cla-202001) if create a PR. | ||
|
||
This is a fork of rcloneExplorer by [Patryk Kaczmarkiewicz](https://github.com/kaczmarkiewiczp). For the parent repository, see [kaczmarkiewiczp/rcloneExplorer](https://github.com/kaczmarkiewiczp/rcloneExplorer). If you want to convey a modified version (fork), we ask you to use a different name, app icon and package id as well as proper attribution to avoid user confusion. | ||
This is a fork of rcloneExplorer by [Patryk Kaczmarkiewicz](https://github.com/kaczmarkiewiczp). For the original repository, see [kaczmarkiewiczp/rcloneExplorer](https://github.com/kaczmarkiewiczp/rcloneExplorer). If you want to convey a modified version (fork), we ask you to use a different name, app icon and package id as well as proper attribution to avoid user confusion. | ||
|
||
### Libraries | ||
- [rclone](https://github.com/rclone/rclone) - "rsync for cloud storage" | ||
- [rclone](https://github.com/rclone/rclone) - Calling this a library is an understatement. Without rclone, there would not be RCX. See https://rclone.org/donate/ to support rclone. | ||
- [Jetpack AndroidX](https://developer.android.com/license) | ||
- [Floating Action Button SpeedDial](https://github.com/leinardi/FloatingActionButtonSpeedDial) - A Floating Action Button Speed Dial implementation for Android that follows the Material Design specification. | ||
- [Glide](https://github.com/bumptech/glide) - An image loading and caching library for Android focused on smooth scrolling. | ||
- [Markdown View](https://github.com/falnatsheh/MarkdownView) - MarkdownView is an Android webview with the capablity of loading Markdown text or file and display it as HTML, it uses MarkdownJ and extends Android webview. | ||
- [MarkdownJ](https://github.com/myabc/markdownj) - converts markdown into HTML. | ||
- [Material Design Icons](https://github.com/Templarian/MaterialDesign) - 2200+ Material Design Icons from the Community. | ||
- [Recyclerview Animators](https://github.com/wasabeef/recyclerview-animators) - An Android Animation library which easily add itemanimator to RecyclerView items. | ||
- [Toasty](https://github.com/GrenderG/Toasty) - The usual Toast, but with steroids. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters