diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ 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) diff --git a/README.md b/README.md index 82fe6d9..0dca4ee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Hydrogen with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hydrogen) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Hydrogen 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 Hydrogen 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 @@ -28,7 +28,7 @@ A minimal Matrix chat client, focused on performance, offline functionality, and **Shipped version:** 0.4.1~ynh1 -**Demo:** https://hydrogen.element.io/ +**Demo:** ## Screenshots @@ -36,18 +36,18 @@ A minimal Matrix chat client, focused on performance, offline functionality, and ## Documentation and resources -* Official app website: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/hydrogen_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/hydrogen_ynh/tree/testing --debug or sudo yunohost app upgrade hydrogen -u https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 029d20e..55884c0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Hydrogen pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Hydrogen avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hydrogen) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Hydrogen 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 Hydrogen 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 @@ -25,9 +25,9 @@ Un client de chat Matrix minimal, axé sur les performances, les fonctionnalité - Il s'agit d'une application Web autonome, mais elle peut également être facilement intégrée à un site Web/une application Web existante pour ajouter des fonctionnalités de chat. - Le chargement de parties (inutilisées) de l'application après le chargement initial de la page doit être pris en charge -**Version incluse :** 0.4.1~ynh1 +**Version incluse :** 0.4.1~ynh1 -**Démo :** https://hydrogen.element.io/ +**Démo :** ## Captures d’écran @@ -35,21 +35,21 @@ Un client de chat Matrix minimal, axé sur les performances, les fonctionnalité ## Documentations et ressources -* Site officiel de l’app : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/hydrogen_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/hydrogen_ynh/tree/testing --debug ou sudo yunohost app upgrade hydrogen -u https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..0d4c361 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,56 @@ + + +# Hydrogen para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/hydrogen.svg)](https://dash.yunohost.org/appci/app/hydrogen) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/hydrogen.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/hydrogen.maintain.svg) + +[![Instalar Hydrogen con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hydrogen) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Hydrogen 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 + +A minimal Matrix chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. + +### Features + +- Work well on desktop as well as mobile browsers +- UI components can be easily used in isolation +- It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities. +- Loading (unused) parts of the application after initial page load should be supported + + +**Versión proporcionada:** 0.4.1~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de Hydrogen](./doc/screenshots/hydrogen-large.png) + +## Documentación e recursos + +- Web oficial da app: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug +ou +sudo yunohost app upgrade hydrogen -u https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..c116ef6 --- /dev/null +++ b/README_it.md @@ -0,0 +1,56 @@ + + +# Hydrogen per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/hydrogen.svg)](https://dash.yunohost.org/appci/app/hydrogen) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/hydrogen.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/hydrogen.maintain.svg) + +[![Installa Hydrogen con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hydrogen) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Hydrogen 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 + +A minimal Matrix chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. + +### Features + +- Work well on desktop as well as mobile browsers +- UI components can be easily used in isolation +- It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities. +- Loading (unused) parts of the application after initial page load should be supported + + +**Versione pubblicata:** 0.4.1~ynh1 + +**Prova:** + +## Screenshot + +![Screenshot di Hydrogen](./doc/screenshots/hydrogen-large.png) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/hydrogen_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/hydrogen_ynh/tree/testing --debug +o +sudo yunohost app upgrade hydrogen -u https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**