diff --git a/README.md b/README.md index 061a5e7..1b49cb4 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,51 @@ + + # LimeSurvey for YunoHost [![Integration level](https://dash.yunohost.org/integration/limesurvey.svg)](https://dash.yunohost.org/appci/app/limesurvey) ![](https://ci-apps.yunohost.org/ci/badges/limesurvey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/limesurvey.maintain.svg) -[![Install LimeSurvey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=limesurvey) +[![Install LimeSurvey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=limesurvey) -> *This package allow you to install LimeSurvey quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install LimeSurvey 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 -LimeSurvey is used to create advanced poll. -**Shipped version:** 3.17.1 +Creation and distribution survey tool -**Categories:** Productivity, Poll +**Shipped version:** 3.17.1~ynh1 -## Screenshots +**Demo:** https://demo.example.com -![](https://www.limesurvey.org/images/news/LimeSurvey3Beta/generalsettings.PNG) - -## Configuration - -Before to run the install YunoHost ask you an admin user, you can use it to connecte you on https://your_limesurvey_url/admin/ - -## Documentation - -* YunoHost documentation: There no other documentations, feel free to contribute. +## Disclaimers / important information ## YunoHost specific features - * In private mode, only authorized YunoHost members can create poll, with the public mode, it's possible to create account to people with no YunoHost account. * SSO and LDAP are configured. * Login secured by fail2ban +## Documentation and resources -#### Multi-users support +* Official app website: https://www.limesurvey.org +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://manual.limesurvey.org/LimeSurvey_Manual/fr +* Upstream app code repository: https://github.com/LimeSurvey/LimeSurvey +* YunoHost documentation for this app: https://yunohost.org/app_limesurvey +* Report a bug: https://github.com/YunoHost-Apps/limesurvey_ynh/issues -Not supported. +## Developer info -#### Supported architectures - -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/leed%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/limesurvey%20(Community)/) -* ARMv8-A - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/leed%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/limesurvey%20(Community)%20(%7EARM%7E)/) - -## Limitations - -## Additionnal informations - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/limesurvey_ynh/issues - * Website: https://www.limesurvey.org - * YunoHost website: https://yunohost.org/ - ---- - -Developers infos ----------------- - -**Package by:** ljf - -**Patches author:** Shnoulle - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing --verbose +sudo yunohost app install https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing --debug or -sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing --verbose +sudo yunohost app upgrade limesurvey -u https://github.com/YunoHost-Apps/limesurvey_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..e9439ef --- /dev/null +++ b/README_fr.md @@ -0,0 +1,47 @@ +# LimeSurvey pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/limesurvey.svg)](https://dash.yunohost.org/appci/app/limesurvey) ![](https://ci-apps.yunohost.org/ci/badges/limesurvey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/limesurvey.maintain.svg) +[![Installer LimeSurvey avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=limesurvey) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer LimeSurvey 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 création et diffusion de sondage + +**Version incluse :** 3.17.1~ynh1 + +**Démo :** https://demo.example.com + +## Avertissements / informations importantes + +## YunoHost specific features + +* In private mode, only authorized YunoHost members can create poll, with the public mode, it's possible to create account to people with no YunoHost account. +* SSO and LDAP are configured. +* Login secured by fail2ban +## Documentations et ressources + +* Site officiel de l'app : https://www.limesurvey.org +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://manual.limesurvey.org/LimeSurvey_Manual/fr +* Dépôt de code officiel de l'app : https://github.com/LimeSurvey/LimeSurvey +* Documentation YunoHost pour cette app : https://yunohost.org/app_limesurvey +* Signaler un bug : https://github.com/YunoHost-Apps/limesurvey_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing --debug +ou +sudo yunohost app upgrade limesurvey -u https://github.com/YunoHost-Apps/limesurvey_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file