From c81f14f24c72283fbceadc5429e846c366f5ee5c Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Wed, 26 Jan 2022 22:37:04 +0000 Subject: [PATCH] Auto-update README --- README.md | 50 ++++++++++++++++++++-------------------- README_fr.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+), 25 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 2dc03c5..53f186c 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,35 @@ + + # æneria for YunoHost -[![Integration level](https://dash.yunohost.org/integration/aeneria.svg)](https://dash.yunohost.org/appci/app/aeneria) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/aeneria.svg)](https://dash.yunohost.org/appci/app/aeneria) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.maintain.svg) [![Install æneria with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=aeneria) -> *This package allows you to install æeneria quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install æneria 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 + The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to: * Better understand our own energy consumption * Analyse energy consumption throw weather data - **Shipped version:** 1.1.6 + +**Shipped version:** 1.1.6~ynh2 + + ## Screenshots -![æneria startup screen](https://gitlab.com/aeneria/aeneria-app/-/raw/master/docs/img/dash_accueil.png) +![](./doc/screenshots/screenshot1.png) + +## Disclaimers / important information ## Configuration @@ -25,10 +38,6 @@ The idea of [æneria](https://aeneria.com) is to display energy consumption and * After that, install æneria to your Yunohost instance, visit it and just follow instructions * That's it, now wait a bit to see data appear ! -## Documentation - -More information can be found on [æneria documentation](https://docs.aeneria.com). - ## Comming from Pilea æneria is the new name of Pilea. This new name came whith a brand new version. @@ -37,24 +46,13 @@ This new version introduced some breaking changes in data structure: migration f But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html). -## YunoHost specific features +## Documentation and resources -* Integrate with YunoHost users and SSO -* Allow one user to be the administrator (set at the installation) -* Allow multiple instances of this application - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/aeneria%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/aeneria/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/aeneria%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/aeneria/) - -## Links - - * æneria website: https://aeneria.com/ - * æneria repo: https://gitlab.com/aeneria/aeneria-app - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://aeneria.com +* Official admin documentation: https://docs.aeneria.com +* Upstream app code repository: https://gitlab.com/aeneria/aeneria-app +* YunoHost documentation for this app: https://yunohost.org/app_aeneria +* Report a bug: https://github.com/YunoHost-Apps/aeneria_ynh/issues ## Developer info @@ -66,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/aeneria_ynh/tree/test or sudo yunohost app upgrade aeneria -u https://github.com/YunoHost-Apps/aeneria_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..dbb52bb --- /dev/null +++ b/README_fr.md @@ -0,0 +1,64 @@ +# æneria pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/aeneria.svg)](https://dash.yunohost.org/appci/app/aeneria) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.maintain.svg) +[![Installer æneria avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=aeneria) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer æneria 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 + +The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to: + + * Better understand our own energy consumption + * Analyse energy consumption throw weather data + + +**Version incluse :** 1.1.6~ynh2 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot1.png) + +## Avertissements / informations importantes + +## Configuration + +* First of all, you'll need a Linky and an [Enedis account](https://mon-compte-client.enedis.fr/) +* In your Enedis space, go to ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/) tab, and allow Enedis to collect and store your hourly consumption +* After that, install æneria to your Yunohost instance, visit it and just follow instructions +* That's it, now wait a bit to see data appear ! + +## Comming from Pilea + +æneria is the new name of Pilea. This new name came whith a brand new version. + +This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly. + +But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html). + +## Documentations et ressources + +* Site officiel de l'app : https://aeneria.com +* Documentation officielle de l'admin : https://docs.aeneria.com +* Dépôt de code officiel de l'app : https://gitlab.com/aeneria/aeneria-app +* Documentation YunoHost pour cette app : https://yunohost.org/app_aeneria +* Signaler un bug : https://github.com/YunoHost-Apps/aeneria_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing --debug +ou +sudo yunohost app upgrade aeneria -u https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file