mirror of
https://github.com/recloudstream/cloudstream.git
synced 2024-08-15 01:53:11 +00:00
Committing this will update the Read.Me, Including a table of contents, descriptions of the project, and links to documentation relating to the project.
104 lines
4.6 KiB
Markdown
104 lines
4.6 KiB
Markdown
# CloudStream
|
|
|
|
**⚠️ Warning: By default, this app doesn't provide any video sources; you have to install extensions to add functionality to the app.**
|
|
|
|
## Table of Contents:
|
|
+ [About Us:](#about_us)
|
|
+ [Installation Steps:](#install_rules)
|
|
+ [Contributing:](#contributing)
|
|
+ [Issues:](#issues)
|
|
+ [Bugs:](#bug_report)
|
|
+ [Enhancement:](#enhancment)
|
|
+ [Extension Development:](#extensions)
|
|
+ [Languauge Support:](#languages)
|
|
+ [Further Sources and Social:](#contact_and_sources)
|
|
|
|
|
|
<a id="about_us"></a>
|
|
|
|
## About us:
|
|
|
|
**CloudStream is an open-source Android app that streams and downloads movies, TV series, and anime. We provide all of this content ad-free and without subscription or sign-up requirements.**
|
|
|
|
#### Features:
|
|
+ **AdFree**, No ads whatsoever
|
|
+ No tracking/analytics
|
|
+ Bookmarks
|
|
+ Phone and TV support
|
|
+ Chromecast
|
|
+ Extension system for personal customization
|
|
|
|
<a id="install_rules"></a>
|
|
|
|
## Installation:
|
|
|
|
Our documentation provides the steps to Install Cloudstream. The steps are simple and extensively customizable for your streaming needs!
|
|
|
|
[Getting Started With CloudStream:](https://recloudstream.github.io/csdocs/)
|
|
|
|
<a id="contributing"></a>
|
|
|
|
## Contributing:
|
|
We **happily** accept any contributions to our project. To find out where you can start contributing towards the project, please look [at our issues tab](/cloudstream/issues)
|
|
While we do not have intensive syntax rules for pull requests, it's appreciated that you follow the following rules when creating an issue:
|
|
|
|
<a id="issues"></a>
|
|
|
|
### Issues:
|
|
While we **actively** accept issues and pull requests, we do not have any syntaxial rules; for issue contributions, however, it is heavily appreciated if your issue includes the following:
|
|
|
|
<a id="bug_report"></a>
|
|
|
|
#### Bug Reports:
|
|
+ A Short but Descriptive Title that accurately describes the bug and the issue.
|
|
+ Steps to reproduce: Make sure that the bug is reproducible And describe the steps in brief but descriptive steps
|
|
+ Make sure you include the version and the commit hash of the version of CloudStream that the bug appeared in
|
|
+ Make sure you include a description of the expected behavior of the program and the actual behavior of the bug
|
|
+ Make sure to include the "bug" label for the issue
|
|
|
|
<a id="enhancment"></a>
|
|
|
|
#### Enhancement:
|
|
+ Before you add your Enhancement report, ensure the enhancement is reasonable and reasonably simple to implement; instead of asking for an entire UI redo, focus on a specific area that needs work.
|
|
+ Ensure the enhancement will fix an issue, such as some settings missing key or accessibility features.
|
|
+ Please describe an example of how the enhancement would be implemented and Why It is helpful.
|
|
+ Make sure to include the "enhancement" label for the issue.
|
|
|
|
It is also important to ensure that an issue is not duplicated or related to another open issue before recording it.
|
|
|
|
<a id="extensions"></a>
|
|
|
|
### Extensions:
|
|
|
|
**Further details on creating extensions for CloudStream are found on our website. **
|
|
|
|
[Guide: For Extension Developers](https://recloudstream.github.io/csdocs/devs/gettingstarted/)
|
|
|
|
<a id="contact_and_sources"></a>
|
|
|
|
## Further Sources and Social:
|
|
|
|
As well as providing clear install steps, our [website](https://dweb.link/ipns/cloudstream.on.fleek.co/) includes a wide variety of other tools, such as:
|
|
- [Troubleshooting](https://recloudstream.github.io/csdocs/troubleshooting/)
|
|
- [Further CloudStream Repositories](https://recloudstream.github.io/csdocs/repositories/)
|
|
- [Recommened Sources For CloudStream](https://recloudstream.github.io/csdocs/recsrc/)
|
|
- [Recommened Apps For CloudStream](https://recloudstream.github.io/csdocs/recapps/)
|
|
- Set-Up for other devices, such as:
|
|
- [Android Tv](https://recloudstream.github.io/csdocs/other-devices/tv/)
|
|
- [Windows](https://recloudstream.github.io/csdocs/other-devices/windows/)
|
|
- [Linux](https://recloudstream.github.io/csdocs/other-devices/linux/)
|
|
- And more...
|
|
|
|
We have a discord server that helps host our passionate community. There, you can hang out and chat with other users of CloudStream, Discuss problems among fellow developers on the project, help with issues, or find guides relating to CloudStream use and development.
|
|
|
|
[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM)
|
|
|
|
<a id="languages"> </a>
|
|
|
|
### Supported languages:
|
|
|
|
Even if you can't contribute to the code or documentation, we always contribute to translation and language support. It's exceptionally appreciated; you can check our translation from the figure below.
|
|
|
|
<a href="https://hosted.weblate.org/engage/cloudstream/">
|
|
<img src="https://hosted.weblate.org/widgets/cloudstream/-/app/multi-auto.svg" alt="Translation status" />
|
|
</a>
|