diff --git a/README.md b/README.md index 076d4ed..7e3652c 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,38 @@ + + # Ampache for YunoHost [![Integration level](https://dash.yunohost.org/integration/ampache.svg)](https://dash.yunohost.org/appci/app/ampache) ![](https://ci-apps.yunohost.org/ci/badges/ampache.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ampache.maintain.svg) [![Install Ampache with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ampache) -> *This package allow you to install Ampache quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/install) to know how to install and enjoy it.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Ampache 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 + [Ampache](http://ampache.org) for the love of music. A web based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet enabled device. -**Shipped version:** 4.4.2 - -## Screenshots - -![](http://ampache.org/img/previews/visualizer.jpg) - -## Demo - -* [YunoHost demo](https://demo.yunohost.org/ampache/) -* [Official demo](http://ampache.org/demo.html) - -## Configuration - -## Documentation - - * Official documentation: https://github.com/ampache/ampache/wiki - * YunoHost documentation: https://yunohost.org/en/app_ampache - -## YunoHost specific features - -In addition to Ampache core features, the following are made available with -this package: +###features * Config for high quality streaming with high bandwith * Quick loading for mobile devices with potential low bandwith * Integrate with YunoHost users - same username and password * Allow one user to be the administrator (set at the installation) -#### Multi-users support +**Shipped version:** 5.2.1~ynh1 - * Ampache is connect to Yunohost LDAP - * No auto SSO yet -#### Supported architectures -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ampache.svg)](https://ci-apps.yunohost.org/ci/apps/ampache/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ampache.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ampache/) +## Screenshots + +![](./doc/screenshots/visualizer.png) + +## Disclaimers / important information ## Limitations @@ -78,18 +65,14 @@ this package: * Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues - * Ampache website: http://ampache.org/ - * Ampache repository: https://github.com/ampache/ampache - * YunoHost website: https://yunohost.org/ +* YunoHost documentation for this app: https://yunohost.org/app_ampache +* Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues ---- +## Developer info -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/ampache_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ampache_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -97,3 +80,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ampache_ynh/tree/test or sudo yunohost app upgrade ampache -u https://github.com/YunoHost-Apps/ampache_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..ee22550 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,80 @@ +# Ampache pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/ampache.svg)](https://dash.yunohost.org/appci/app/ampache) ![](https://ci-apps.yunohost.org/ci/badges/ampache.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ampache.maintain.svg) +[![Installer Ampache avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ampache) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Ampache rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +[Ampache](http://ampache.org) for the love of music. A web based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet enabled device. + +###features + + * Config for high quality streaming with high bandwith + * Quick loading for mobile devices with potential low bandwith + * Integrate with YunoHost users - same username and password + * Allow one user to be the administrator (set at the installation) + +**Version incluse :** 5.2.1~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/visualizer.png) + +## Avertissements / informations importantes + +## Limitations + +* Also, the SSO authentication not fully working from user panel, we have to work about this. In fact, it can disrupt external Ampache clients like Subsonic. + +## Additionnal informations + +### Getting started + + * **Add your first catalog to load music files** + * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Click on *Add a Catalog* + * Fill up fields and click *Add Calalog* + * Next, enjoy :) + + * **Update a catalog for load new music files** + * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Click on *Show Catalogs* + * Select *Update* in *Actions* list and click *Go* + + * **Change interface Language** + * Go to *Preferences panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_edit.png) + * Click on *Interface* + * Change *Language* field + +### Ampache on mobile devices + + * [For Android](https://play.google.com/store/apps/details?id=com.antoniotari.reactiveampacheapp) + * [For iOS](http://iampache.com/) + + * Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients + +## Documentations et ressources + +* Documentation YunoHost pour cette app : https://yunohost.org/app_ampache +* Signaler un bug : https://github.com/YunoHost-Apps/ampache_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ampache_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/ampache_ynh/tree/testing --debug +ou +sudo yunohost app upgrade ampache -u https://github.com/YunoHost-Apps/ampache_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file