From dc6aae4461156108cd393a2bfb4cf011f26623a7 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 27 Jun 2021 09:57:56 +0000 Subject: [PATCH] Auto-update README --- README.md | 64 +++++++++++++++++++++------------------------------- README_fr.md | 51 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 38 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index b23e7ee..f570b48 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,56 @@ + + # Airsonic for YunoHost [![Integration level](https://dash.yunohost.org/integration/airsonic.svg)](https://dash.yunohost.org/appci/app/airsonic) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.maintain.svg) [![Install Airsonic with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=airsonic) -> *This package allow you to install Airsonic 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 Airsonic 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 -Airsonic is a free, web-based media streamer, providing ubiquitous access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. +Stream and manage your music collection -Airsonic is designed to handle very large music collections (hundreds of gigabytes). Although optimized for MP3 streaming, it works for any audio or video format that can stream over HTTP, for instance AAC and OGG. By using transcoder plug-ins, Airsonic supports on-the-fly conversion and streaming of virtually any audio format, including WMA, FLAC, APE, Musepack, WavPack and Shorten. +**Shipped version:** 10.6.2~ynh2 -If you have constrained bandwidth, you may set an upper limit for the bit rate of the music streams. Airsonic will then automatically re sample the music to a suitable bit rate. - -In addition to being a streaming media server, Airsonic works very well as a local jukebox. The intuitive web interface, as well as search and index facilities, are optimized for efficient browsing through large media libraries. Airsonic also comes with an integrated Podcast receiver, with many of the same features as you find in iTunes. - -**Shipped version:** 10.6.2 +**Demo:** https://airsonic.github.io/demo/ ## Screenshots -![Sreenshot of home page of Airsonic](screenshot_01.png) +![](./doc/screenshots/screenshot_01.png) -## Demo - -* [Official demo](https://airsonic.github.io/demo/) - -## Configuration - -How to configure this app: by an admin panel. - -## Documentation - -* Official documentation: https://airsonic.github.io/docs +## Disclaimers / important information ## YunoHost specific features -* YunoHost LDAP accounts supported: you can login with them +* YunoHost LDAP accounts supported: **Yes** * [Multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) handled * Memory RAM limit set to 256 MB because Airsonic was often killed by lack of RAM (hello OOM killer) - * See https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/ +* See https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/ -## Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/airsonic.svg)](https://ci-apps.yunohost.org/ci/apps/airsonic/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/airsonic.svg)](https://ci-apps-arm.yunohost.org/ci/apps/airsonic/) - -## Links +## Documentation and resources +* Official app website: https://airsonic.github.io/ +* Official admin documentation: https://airsonic.github.io/docs/ +* Upstream app code repository: https://github.com/airsonic/airsonic +* YunoHost documentation for this app: https://yunohost.org/app_airsonic * Report a bug: https://github.com/YunoHost-Apps/airsonic_ynh/issues -* App website: https://airsonic.github.io/ -* Upstream app repository: https://github.com/airsonic/airsonic -* YunoHost website: https://yunohost.org/ ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing). To try the testing branch, please proceed like that. - -```bash +``` sudo yunohost app install https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug or sudo yunohost app upgrade airsonic -u https://github.com/YunoHost-Apps/airsonic_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..2b95d6d --- /dev/null +++ b/README_fr.md @@ -0,0 +1,51 @@ +# Airsonic pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/airsonic.svg)](https://dash.yunohost.org/appci/app/airsonic) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.maintain.svg) +[![Installer Airsonic avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=airsonic) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Airsonic 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 + +Streamez et gérez votre collection de musique + +**Version incluse :** 10.6.2~ynh2 + +**Démo :** https://airsonic.github.io/demo/ + +## Captures d'écran + +![](./doc/screenshots/screenshot_01.png) + +## Avertissements / informations importantes + +## Fonctionnalités spécifiques à YunoHost + +* Comptes LDAP YunoHost pris en charge : **oui** +* [Multimédia](https://github.com/YunoHost-Apps/yunohost.multimedia) géré +* Limite de mémoire RAM fixée à 256 Mb car Airsonic quittait souvant par manque de RAM (bonjour OOM killer) +* Voir https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/ +## Documentations et ressources + +* Site officiel de l'app : https://airsonic.github.io/ +* Documentation officielle de l'admin : https://airsonic.github.io/docs/ +* Dépôt de code officiel de l'app : https://github.com/airsonic/airsonic +* Documentation YunoHost pour cette app : https://yunohost.org/app_airsonic +* Signaler un bug : https://github.com/YunoHost-Apps/airsonic_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug +ou +sudo yunohost app upgrade airsonic -u https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file