1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mstream_ynh.git synced 2024-09-03 19:46:17 +02:00
mstream_ynh/README.md

54 lines
2 KiB
Markdown

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
It shall NOT be edited by hand.
-->
# mStream for YunoHost
[![Integration level](https://dash.yunohost.org/integration/mstream.svg)](https://dash.yunohost.org/appci/app/mstream) ![Working status](https://ci-apps.yunohost.org/ci/badges/mstream.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mstream.maintain.svg)
[![Install mStream with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mstream)
*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install mStream quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.
### Features
- Light on memory and CPU
- Tested on multi-terabyte libraries
- Runs on ARM boards like the Raspberry Pi
**Shipped version:** 5.12.0~ynh1
**Demo:** <https://demo.mstream.io/>
## Screenshots
![Screenshot of mStream](./doc/screenshots/mstreamv5.png)
## Documentation and resources
- Official app website: <https://mstream.io/>
- Upstream app code repository: <https://github.com/IrosTheBeggar/mStream>
- YunoHost Store: <https://apps.yunohost.org/app/mstream>
- Report a bug: <https://github.com/YunoHost-Apps/mstream_ynh/issues>
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/mstream_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/mstream_ynh/tree/testing --debug
or
sudo yunohost app upgrade mstream -u https://github.com/YunoHost-Apps/mstream_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>