Auto-update README

2024-09-03 19:55:52 +02:00 · 2022-01-25 01:20:52 +00:00 · 2022-01-25 01:20:52 +00:00 · 2869f94e43
commit 2869f94e43
parent 1da7853984
2 changed files with 43 additions and 61 deletions
--- a/README.md
+++ b/README.md
@ -1,57 +1,48 @@
-# `mygpo` (gPodder.net) for YunoHost
+<!--
+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.
+-->
+
+# mygpo (gPodder.net) for YunoHost

 [![Integration level](https://dash.yunohost.org/integration/mygpo.svg)](https://dash.yunohost.org/appci/app/mygpo) ![](https://ci-apps.yunohost.org/ci/badges/mygpo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mygpo.maintain.svg)  
-[![Install mygpo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mygpo)
+[![Install mygpo (gPodder.net) with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mygpo)

 *[Lire ce readme en français.](./README_fr.md)*

-> *This package allows you to install mygpo 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.*
+> *This package allows you to install mygpo (gPodder.net) 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

 This is the webservice powering the https://gpodder.net website. It can be used to sync podcast subscriptions with [supported clients](https://gpoddernet.readthedocs.io/en/latest/user/clients.html).

-**Shipped version:** 2021-10-20
-
-## Screenshots
-
-![](https://github.com/YunoHost-Apps/mygpo_ynh/raw/master/screenshot.png)
-
-## Demo
-
-* [Official demo](https://gpodder.net)
-
 ## Configuration

 Edit files under `/opt/yunohost/APPDIR/envs/prod` to set environment variables. There is an admin interface at `yourdomain.tld/admin` that the admin user can log in to.

-## Documentation

-* Official documentation: https://gpoddernet.readthedocs.io/
+**Shipped version:** 2.11.20211020~ynh1

-#### Multi-user support
+**Demo:** https://gpodder.net

-* Are LDAP and HTTP auth supported? **LDAP only**
-* Can the app be used by multiple users? **Yes**
+## Screenshots

-#### Supported architectures
+![](./doc/screenshots/screenshot1.png)

-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mygpo%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mygpo/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mygpo%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mygpo/)
+## Disclaimers / important information

 ## Limitations

 * The feed-parsing service is not included, https://feeds.gpodder.net is used

-## Links
+## Documentation and resources

+* Official app website: https://gpodder.net
+* Official admin documentation: https://gpoddernet.readthedocs.io/
+* Upstream app code repository: https://github.com/gpodder/mygpo
+* YunoHost documentation for this app: https://yunohost.org/app_mygpo
 * Report a bug: https://github.com/YunoHost-Apps/mygpo_ynh/issues
-* App website: https://gpodder.net
-* Upstream app repository: https://github.com/gpodder/mygpo
-* YunoHost website: https://yunohost.org/
-
---

 ## Developer info

@ -61,5 +52,7 @@ To try the testing branch, please proceed like that.
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/mygpo_ynh/tree/testing --debug
 or
-sudo yunohost app upgrade mygpo -u https://github.com/YunoHost-Apps/mygpo_ynh/tree/testing --debuggit 
+sudo yunohost app upgrade mygpo -u https://github.com/YunoHost-Apps/mygpo_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
--- a/README_fr.md
+++ b/README_fr.md
@ -1,57 +1,44 @@
-# `mygpo` (gPodder.net) pour YunoHost
+# mygpo (gPodder.net) pour YunoHost

 [![Niveau d'intégration](https://dash.yunohost.org/integration/mygpo.svg)](https://dash.yunohost.org/appci/app/mygpo) ![](https://ci-apps.yunohost.org/ci/badges/mygpo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mygpo.maintain.svg)  
-[![Installer mygpo avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mygpo)
+[![Installer mygpo (gPodder.net) avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mygpo)

 *[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*

-> *Ce package vous permet d'installer mygpo rapidement et simplement sur un serveur YunoHost.  
-Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
+> *Ce package vous permet d'installer mygpo (gPodder.net) 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

-Ceci est le service derrière https://gpodder.net. Il peut servir pour synchronizer vos flux balado entre [clients compatibles](https://gpoddernet.readthedocs.io/en/latest/user/clients.html).
-
-**Version incluse :** 2021-10-20
-
-## Captures d'écran
-
-![](https://github.com/YunoHost-Apps/mygpo_ynh/raw/master/screenshot.png)
-
-## Démo
-
-* [Démo officielle](https://gpodder.net)
+This is the webservice powering the https://gpodder.net website. It can be used to sync podcast subscriptions with [supported clients](https://gpoddernet.readthedocs.io/en/latest/user/clients.html).

 ## Configuration

-Modifiez les fichiers sous `/opt/yunohost/APPDIR/envs/prod` pour configurer les variables d'environment. Il y a une interface admin a `votre-domaine.tld/admin` (seulement accessible par l'administrateur).
+Edit files under `/opt/yunohost/APPDIR/envs/prod` to set environment variables. There is an admin interface at `yourdomain.tld/admin` that the admin user can log in to.

-## Documentation

-* Documentation officielle : https://gpoddernet.readthedocs.io/
+**Version incluse :** 2.11.20211020~ynh1

-#### Support multi-utilisateur
+**Démo :** https://gpodder.net

-* L'authentification LDAP et HTTP est-elle prise en charge ? **Seulement LDAP**
-* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
+## Captures d'écran

-#### Architectures supportées
+![](./doc/screenshots/screenshot1.png)

-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mygpo%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mygpo/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mygpo%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mygpo/)
+## Avertissements / informations importantes

 ## Limitations

-* Le service d'analyse de flux n'est pas inclu, https://feeds.gpodder.net est utilisé
+* The feed-parsing service is not included, https://feeds.gpodder.net is used

-## Liens
+## Documentations et ressources

- * Signaler un bug : https://github.com/YunoHost-Apps/mygpo_ynh/issues
- * Site de l'application : https://gpodder.net
- * Dépôt de l'application principale : https://github.com/gpodder/mygpo
- * Site web YunoHost : https://yunohost.org/
-
---
+* Site officiel de l'app : https://gpodder.net
+* Documentation officielle de l'admin : https://gpoddernet.readthedocs.io/
+* Dépôt de code officiel de l'app : https://github.com/gpodder/mygpo
+* Documentation YunoHost pour cette app : https://yunohost.org/app_mygpo
+* Signaler un bug : https://github.com/YunoHost-Apps/mygpo_ynh/issues

 ## Informations pour les développeurs

@ -63,3 +50,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/mygpo_ynh/tree/testin
 ou
 sudo yunohost app upgrade mygpo -u https://github.com/YunoHost-Apps/mygpo_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps