Auto-update README

2024-09-03 19:36:25 +02:00 · 2024-03-29 07:12:07 +01:00 · 2024-03-29 07:12:07 +01:00 · fabdf08036
commit fabdf08036
parent 5b5ff9eb8a
5 changed files with 201 additions and 27 deletions
--- a/ALL_README.md
+++ b/ALL_README.md
@ -0,0 +1,6 @@
+# All available README files by language
+
+- [Read the README in English](README.md)
+- [Lire le README en français](README_fr.md)
+- [Le o README en galego](README_gl.md)
+- [Leggi il “README” in italiano](README_it.md)
--- a/README.md
+++ b/README.md
@ -1,5 +1,5 @@
 <!--
-N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+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.
 -->

@ -9,10 +9,10 @@ It shall NOT be edited by hand.

 [![Install Matrix-Discord bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)

-*[Lire ce readme en français.](./README_fr.md)*
+*[Read this README is other languages.](./ALL_README.md)*

-> *This package allows you to install Matrix-Discord bridge 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 Matrix-Discord bridge 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

@ -53,21 +53,25 @@ After the install is complete, start a chat with `@_discordpuppet_bot:yourserver

 You also may modify the `/etc/matrix-puppet-discord/user.config.yaml` file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (`systemctl restart matrix-puppet-discord`).

+## :red_circle: Antifeatures
+
+- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.
+
 ## Documentation and resources

-* Official app website: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* Official admin documentation: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* Upstream app code repository: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* YunoHost Store: <https://apps.yunohost.org/app/matrix-puppet-discord>
-* Report a bug: <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>
+- Official app website: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Official admin documentation: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Upstream app code repository: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- YunoHost Store: <https://apps.yunohost.org/app/matrix-puppet-discord>
+- Report a bug: <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>

 ## Developer info

-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
+Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).

-To try the testing branch, please proceed like that.
+To try the `testing` branch, please proceed like that:

-``` bash
+```bash
 sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
--- a/README_fr.md
+++ b/README_fr.md
@ -1,6 +1,6 @@
 <!--
-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.
+Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
+Il NE doit PAS être modifié à la main.
 -->

 # Matrix-Discord bridge pour YunoHost
@ -9,10 +9,10 @@ It shall NOT be edited by hand.

 [![Installer Matrix-Discord bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)

-*[Read this readme in english.](./README.md)*
+*[Lire le README dans d'autres langues.](./ALL_README.md)*

-> *Ce package vous permet d’installer Matrix-Discord bridge 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.*
+> *Ce package vous permet d’installer Matrix-Discord bridge rapidement et simplement sur un serveur YunoHost.*  
+> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*

 ## Vue d’ensemble

@ -41,7 +41,7 @@ Ceci est une passerelle vers Discord pour Matrix. Il gère la messagerie privée
 Voir la documentation sur <https://gitlab.com/mx-puppet/discord/mx-puppet-discord> (en anglais).


-**Version incluse :** 0.1.7~ynh4
+**Version incluse :** 0.1.7~ynh4

 ## Captures d’écran

@ -53,24 +53,28 @@ Après l'installation, lancer une conversation privée avec `@_discordpuppet_bot

 Vous pouvez par ailleurs modifier le fichier `/etc/matrix-puppet-discord/user.config.yaml` pour personnaliser la configuration (notamment les permissions pour utiliser la passerelle). Redémarrez bien ensuite la passerelle pour que les modifications soient effectives (`systemctl restart matrix-puppet-discord`).

+## :red_circle: Anti-fonctionnalités
+
+- **Application non maintenue**: Ce logiciel n'est plus maintenu. Attendez-vous à ce qu'il ne fonctionne plus avec le temps, et que l'on découvre des failles de sécurité qui ne seront pas corrigées, etc.
+
 ## Documentations et ressources

-* Site officiel de l’app : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* Documentation officielle de l’admin : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* Dépôt de code officiel de l’app : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
-* YunoHost Store: <https://apps.yunohost.org/app/matrix-puppet-discord>
-* Signaler un bug : <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>
+- Site officiel de l’app : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Documentation officielle de l’admin : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Dépôt de code officiel de l’app : <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- YunoHost Store : <https://apps.yunohost.org/app/matrix-puppet-discord>
+- Signaler un bug : <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>

 ## Informations pour les développeurs

-Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
+Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).

-Pour essayer la branche testing, procédez comme suit.
+Pour essayer la branche `testing`, procédez comme suit :

-``` bash
+```bash
 sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
 ```

-**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
--- a/README_gl.md
+++ b/README_gl.md
@ -0,0 +1,80 @@
+<!--
+NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
+NON debe editarse manualmente.
+-->
+
+# Matrix-Discord bridge para YunoHost
+
+[![Nivel de integración](https://dash.yunohost.org/integration/matrix-puppet-discord.svg)](https://dash.yunohost.org/appci/app/matrix-puppet-discord) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.maintain.svg)
+
+[![Instalar Matrix-Discord bridge con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)
+
+*[Le este README en outros idiomas.](./ALL_README.md)*
+
+> *Este paquete permíteche instalar Matrix-Discord bridge de xeito rápido e doado nun servidor YunoHost.*  
+> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
+
+## Vista xeral
+
+This is a discord puppeting bridge for matrix. It handles bridging private and group DMs, as well as Guilds (servers). It is based on [mx-puppet-bridge](https://gitlab.com/mx-puppet/mx-puppet-bridge).
+
+### Features
+
+- Direct (1:1) Chats
+- DM Group Chats
+- Plain Text
+- Formatted Messages
+- Media/files
+- Redactions/Deletions
+- Presence (Discord → Matrix only)
+- Typing notifications (Discord → Matrix only)
+- Replies
+- Edits
+- Reactions
+- Stickers
+- Multi-user
+- Friends management
+- Initiate chats from matrix
+
+### How to
+
+See <https://gitlab.com/mx-puppet/discord/mx-puppet-discord> for documentation.
+
+
+**Versión proporcionada:** 0.1.7~ynh4
+
+## Capturas de pantalla
+
+![Captura de pantalla de Matrix-Discord bridge](./doc/screenshots/example.jpg)
+
+## Avisos / información importante
+
+After the install is complete, start a chat with `@_discordpuppet_bot:yourserver.com`. When it joins, type `help` in the chat to see instructions.
+
+You also may modify the `/etc/matrix-puppet-discord/user.config.yaml` file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (`systemctl restart matrix-puppet-discord`).
+
+## :red_circle: Caraterísticas cuestionables
+
+- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.
+
+## Documentación e recursos
+
+- Web oficial da app: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Documentación oficial para admin: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Repositorio de orixe do código: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Tenda YunoHost: <https://apps.yunohost.org/app/matrix-puppet-discord>
+- Informar dun problema: <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>
+
+## Info de desenvolvemento
+
+Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
+
+Para probar a rama `testing`, procede deste xeito:
+
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
+```
+
+**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>
--- a/README_it.md
+++ b/README_it.md
@ -0,0 +1,80 @@
+<!--
+N.B.: Questo README è stato automaticamente generato da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
+NON DEVE essere modificato manualmente.
+-->
+
+# Matrix-Discord bridge per YunoHost
+
+[![Livello di integrazione](https://dash.yunohost.org/integration/matrix-puppet-discord.svg)](https://dash.yunohost.org/appci/app/matrix-puppet-discord) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.maintain.svg)
+
+[![Installa Matrix-Discord bridge con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)
+
+*[Leggi questo README in altre lingue.](./ALL_README.md)*
+
+> *Questo pacchetto ti permette di installare Matrix-Discord bridge su un server YunoHost in modo semplice e veloce.*  
+> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.*
+
+## Panoramica
+
+This is a discord puppeting bridge for matrix. It handles bridging private and group DMs, as well as Guilds (servers). It is based on [mx-puppet-bridge](https://gitlab.com/mx-puppet/mx-puppet-bridge).
+
+### Features
+
+- Direct (1:1) Chats
+- DM Group Chats
+- Plain Text
+- Formatted Messages
+- Media/files
+- Redactions/Deletions
+- Presence (Discord → Matrix only)
+- Typing notifications (Discord → Matrix only)
+- Replies
+- Edits
+- Reactions
+- Stickers
+- Multi-user
+- Friends management
+- Initiate chats from matrix
+
+### How to
+
+See <https://gitlab.com/mx-puppet/discord/mx-puppet-discord> for documentation.
+
+
+**Versione pubblicata:** 0.1.7~ynh4
+
+## Screenshot
+
+![Screenshot di Matrix-Discord bridge](./doc/screenshots/example.jpg)
+
+## Attenzione/informazioni importanti
+
+After the install is complete, start a chat with `@_discordpuppet_bot:yourserver.com`. When it joins, type `help` in the chat to see instructions.
+
+You also may modify the `/etc/matrix-puppet-discord/user.config.yaml` file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (`systemctl restart matrix-puppet-discord`).
+
+## :red_circle: Anti-funzionalità
+
+- **Applicazione non mantenuta**: Questo software non è più mantenuto. Ci si può aspettare che con il passare del tempo smetta di funzionare, sia esposto a falle di sicurezza, ecc.
+
+## Documentazione e risorse
+
+- Sito web ufficiale dell’app: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Documentazione ufficiale per gli amministratori: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Repository upstream del codice dell’app: <https://gitlab.com/mx-puppet/discord/mx-puppet-discord>
+- Store di YunoHost: <https://apps.yunohost.org/app/matrix-puppet-discord>
+- Segnala un problema: <https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues>
+
+## Informazioni per sviluppatori
+
+Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
+
+Per provare la branch di `testing`, si prega di procedere in questo modo:
+
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
+o
+sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
+```
+
+**Maggiori informazioni riguardo il pacchetto di quest’app:** <https://yunohost.org/packaging_apps>