diff --git a/README.md b/README.md index c8d39df..5f8b4b0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # 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) @@ -5,63 +10,29 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Galette quickly and simply on a YunoHost server. +> *This package allows you to install Galette 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 -Galette is a membership management web application towards non profit organizations. -**Shipped version:** 0.9.4.2 +Membership management web application for non profit organizations -## Screenshots +**Shipped version:** 0.9.5~ynh1 -![](https://galette.eu/site/assets/images/screenshots/edit_member.png) +**Demo:** https://demo.galette.eu/login -## Demo +## Documentation and resources -* [Official demo](https://demo.galette.eu/login) - -## Configuration - -How to configure this app: From an admin panel, a plain file with SSH, or any other way. - -## Documentation - - * Official documentation: https://doc.galette.eu/fr/master/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - - * Are LDAP and HTTP auth supported? - * Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/galette%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/galette/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/galette%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/galette/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/galette_ynh/issues - * App website: http://galette.eu/ - * Upstream app repository: https://github.com/galette/galette - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://www.galette.eu +* Official user documentation: https://yunohost.org/apps +* 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 ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +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. ``` @@ -69,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/galette_ynh/tree/test 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 diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..af9c641 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# 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) +[![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.* + +## Vue d'ensemble + +Outil de gestion d'adhérents et de cotisation en ligne pour associations + +**Version incluse :** 0.9.5~ynh1 + +**Démo :** https://demo.galette.eu/login + +## Documentations et ressources + +* Site officiel de l'app : https://www.galette.eu +* Documentation officielle utilisateur : https://yunohost.org/apps +* 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 + +## 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. +``` +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