diff --git a/README.md b/README.md index 0e4de72..42b4c23 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Galette for YunoHost -[![Integration level](https://dash.yunohost.org/integration/galette.svg)](https://dash.yunohost.org/appci/app/galette) ![](https://ci-apps.yunohost.org/ci/badges/galette.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/galette.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/galette.svg)](https://dash.yunohost.org/appci/app/galette) ![Working status](https://ci-apps.yunohost.org/ci/badges/galette.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/galette.maintain.svg) [![Install Galette with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=galette) *[Lire ce readme en français.](./README_fr.md)* @@ -15,40 +15,35 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Membership management web application for non profit organizations +Galette is a membership management web application towards non profit organizations. -**Shipped version:** 0.9.5.2~ynh1 + +**Shipped version:** 0.9.5.2~ynh3 **Demo:** https://demo.galette.eu/login ## Screenshots -![](./doc/screenshots/edit_member.png) - -## Disclaimers / important information - -## Configuration - -1. The app will require to complete the registration process after the instllation is complete by visiting the domain on which Galette is installed. -1. The Postgresql database credentials will be sent to the admin mail. Fill these details while doing the registration process. +![Screenshot of Galette](./doc/screenshots/edit_member.png) ## Documentation and resources -* Official app website: https://www.galette.eu -* Official admin documentation: https://doc.galette.eu/fr/master/ -* Upstream app code repository: https://github.com/galette/galette -* YunoHost documentation for this app: https://yunohost.org/app_galette -* Report a bug: https://github.com/YunoHost-Apps/galette_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/galette_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/galette_ynh/tree/testing --debug or sudo yunohost app upgrade galette -u https://github.com/YunoHost-Apps/galette_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index ed5505e..fd4970a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Galette pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/galette.svg)](https://dash.yunohost.org/appci/app/galette) ![](https://ci-apps.yunohost.org/ci/badges/galette.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/galette.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/galette.svg)](https://dash.yunohost.org/appci/app/galette) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/galette.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/galette.maintain.svg) [![Installer Galette avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=galette) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Galette 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.* @@ -13,38 +17,33 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Outil de gestion d'adhérents et de cotisation en ligne pour associations -**Version incluse :** 0.9.5.2~ynh1 + +**Version incluse :** 0.9.5.2~ynh3 **Démo :** https://demo.galette.eu/login ## Captures d'écran -![](./doc/screenshots/edit_member.png) - -## Avertissements / informations importantes - -## Configuration - -1. Une fois l'installation terminée, l'application devra terminer le processus d'enregistrement en **visitant le domaine** sur lequel Galette est installé. -1. Les informations d'identification de la base de données Postgresql seront envoyées à **l'email admin**. Remplissez ces détails lors du processus d'inscription. +![Capture d'écran de Galette](./doc/screenshots/edit_member.png) ## Documentations et ressources -* Site officiel de l'app : https://www.galette.eu -* Documentation officielle de l'admin : https://doc.galette.eu/fr/master/ -* Dépôt de code officiel de l'app : https://github.com/galette/galette -* Documentation YunoHost pour cette app : https://yunohost.org/app_galette -* Signaler un bug : https://github.com/YunoHost-Apps/galette_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/galette_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/galette_ynh/tree/testing --debug ou sudo yunohost app upgrade galette -u https://github.com/YunoHost-Apps/galette_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**