1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/funkwhale_ynh.git synced 2024-09-03 18:36:24 +02:00
funkwhale_ynh/README.md

51 lines
2.1 KiB
Markdown
Raw Normal View History

2021-10-23 16:53:03 +02:00
<!--
2024-03-29 07:03:48 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2021-10-23 16:53:03 +02:00
It shall NOT be edited by hand.
-->
2020-06-10 08:57:49 +02:00
# Funkwhale for YunoHost
2018-05-11 23:43:58 +02:00
2024-07-15 17:49:16 +02:00
[![Integration level](https://dash.yunohost.org/integration/funkwhale.svg)](https://ci-apps.yunohost.org/ci/apps/funkwhale/) ![Working status](https://ci-apps.yunohost.org/ci/badges/funkwhale.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/funkwhale.maintain.svg)
2023-02-23 23:39:19 +01:00
[![Install Funkwhale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=funkwhale)
2019-04-03 14:35:09 +02:00
2024-04-01 06:01:26 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2020-12-14 21:41:20 +01:00
2024-03-29 07:03:48 +01:00
> *This package allows you to install Funkwhale 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.*
2019-04-03 14:35:09 +02:00
## Overview
2018-05-12 13:17:09 +02:00
2021-11-23 07:46:19 +01:00
Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network.
**Shipped version:** 1.4.0~ynh2
2022-09-14 11:10:20 +02:00
2024-03-29 07:03:48 +01:00
**Demo:** <https://demo.funkwhale.audio>
2022-07-14 14:03:39 +02:00
## Screenshots
![Screenshot of Funkwhale](./doc/screenshots/screenshot1.png)
2021-10-23 16:53:03 +02:00
## Documentation and resources
2024-03-29 07:03:48 +01:00
- Official app website: <https://funkwhale.audio/>
- Official user documentation: <https://docs.funkwhale.audio/users/index.html>
- Official admin documentation: <https://docs.funkwhale.audio/admin/index.html>
- Upstream app code repository: <https://dev.funkwhale.audio/funkwhale/funkwhale>
- YunoHost Store: <https://apps.yunohost.org/app/funkwhale>
- Report a bug: <https://github.com/YunoHost-Apps/funkwhale_ynh/issues>
2019-04-03 14:35:09 +02:00
## Developer info
2019-04-03 14:35:09 +02:00
2024-03-29 07:03:48 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing).
2019-04-03 14:35:09 +02:00
2024-03-29 07:03:48 +01:00
To try the `testing` branch, please proceed like that:
2022-07-13 17:29:01 +02:00
2024-03-29 07:03:48 +01:00
```bash
2019-04-03 14:35:09 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug
or
sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug
```
2021-10-23 16:53:03 +02:00
2022-07-13 17:29:01 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>