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 35a593f..397324f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Domoticz with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Domoticz 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 Domoticz 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 @@ -50,9 +50,9 @@ You may also install the [Mosquitto package](https://github.com/YunoHost-Apps/mo ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index cd0ef43..a89d0c6 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Domoticz pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Domoticz avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Domoticz 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 Domoticz 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 @@ -32,9 +32,7 @@ Il peut par exemple être utilisé avec : Le broker MQTT Mosquitto est intégré au package et nécessite un sous-domaine ou un domaine distinct. Il est optionnel. Vous pouvez également installer le [package pour Mosquitto](https://github.com/YunoHost-Apps/mosquitto_ynh) sans utiliser celui de domoticz_ynh. - - -**Version incluse :** 2024.4~ynh1 +**Version incluse :** 2024.4~ynh1 ## Captures d’écran @@ -43,18 +41,18 @@ Vous pouvez également installer le [package pour Mosquitto](https://github.com/ ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle utilisateur : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- 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/domoticz_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug @@ -62,4 +60,4 @@ ou sudo yunohost app upgrade domoticz -u https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..8942816 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,64 @@ + + +# Domoticz para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/domoticz.svg)](https://dash.yunohost.org/appci/app/domoticz) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/domoticz.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/domoticz.maintain.svg) + +[![Instalar Domoticz con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Domoticz 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 + +Domoticz is a Home Automation system design to control various devices and receive input from various sensors. +For example this system can be used with: + +* Light switches +* Door sensors +* Doorbells +* Security devices +* Weather sensors like: UV/Rain/Wind Meters +* Temperature Sensors +* Pulse Meters +* Voltage / AD Meters +* And more... + + +The MQTT broker Mosquitto is integrated into the package and requires its own domain or subdomain. It's an optional setting. +You may also install the [Mosquitto package](https://github.com/YunoHost-Apps/mosquitto_ynh) without using the one provided by domoticz_ynh. + +**Versión proporcionada:** 2024.4~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Domoticz](./doc/screenshots/domoticz_Switches_screen.png) +![Captura de pantalla de Domoticz](./doc/screenshots/domoticz_floorplan_machineon.png) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- Documentación oficial para admin: +- 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/domoticz_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug +ou +sudo yunohost app upgrade domoticz -u https://github.com/YunoHost-Apps/domoticz_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..875e601 --- /dev/null +++ b/README_it.md @@ -0,0 +1,64 @@ + + +# Domoticz per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/domoticz.svg)](https://dash.yunohost.org/appci/app/domoticz) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/domoticz.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/domoticz.maintain.svg) + +[![Installa Domoticz con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Domoticz 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 + +Domoticz is a Home Automation system design to control various devices and receive input from various sensors. +For example this system can be used with: + +* Light switches +* Door sensors +* Doorbells +* Security devices +* Weather sensors like: UV/Rain/Wind Meters +* Temperature Sensors +* Pulse Meters +* Voltage / AD Meters +* And more... + + +The MQTT broker Mosquitto is integrated into the package and requires its own domain or subdomain. It's an optional setting. +You may also install the [Mosquitto package](https://github.com/YunoHost-Apps/mosquitto_ynh) without using the one provided by domoticz_ynh. + +**Versione pubblicata:** 2024.4~ynh1 + +## Screenshot + +![Screenshot di Domoticz](./doc/screenshots/domoticz_Switches_screen.png) +![Screenshot di Domoticz](./doc/screenshots/domoticz_floorplan_machineon.png) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli utenti: +- Documentazione ufficiale per gli amministratori: +- 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/domoticz_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/domoticz_ynh/tree/testing --debug +o +sudo yunohost app upgrade domoticz -u https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**