diff --git a/README.md b/README.md index ecac3bd..15e233b 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,56 @@ + + # Question2Answer for YunoHost -[![Integration level](https://dash.yunohost.org/integration/question2answer.svg)](https://dash.yunohost.org/appci/app/question2answer) ![](https://ci-apps.yunohost.org/ci/badges/question2answer.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/question2answer.maintain.svg) -[![Install question2answer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=question2answer) +[![Integration level](https://dash.yunohost.org/integration/question2answer.svg)](https://dash.yunohost.org/appci/app/question2answer) ![Working status](https://ci-apps.yunohost.org/ci/badges/question2answer.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/question2answer.maintain.svg) +[![Install Question2Answer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=question2answer) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Question2Answer quickly and simply on a YunoHost server. +> *This package allows you to install Question2Answer 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 + Question2Answer (Q2A) is a popular open source Q&A platform for PHP/MySQL. -**Shipped version:** 1.8.6 + +**Shipped version:** 1.8.6~ynh2 + +**Demo:** http://demo.question2answer.org ## Screenshots -![](./images/install_screenshot.png) +![Screenshot of Question2Answer](./doc/screenshots/install_screenshot.png) -## Demo - -* [Official demo](http://demo.question2answer.org/) +## Disclaimers / important information ## Configuration This app can be configured via its admin panel, available at `https://mydomain/myquestion2answer/index.php/admin/` -## Documentation - * Official documentation: https://www.question2answer.org/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. +## Documentation and resources -## YunoHost specific features - -#### Multi-user support - -This app supports multiuser and LDAP, but is not integrated via SSO. -The admin page is protected by SSOwat. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/question2answer%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/question2answer/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/question2answer%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/question2answer/) - -## Limitations - -* No known limitations. - -## Additional information - -**More info on the documentation page:** -https://yunohost.org/packaging_apps - -## Links - - * Report a bug: https://github.com/nils-van-zuijlen/question2answer_ynh/issues - * App website: https://www.question2answer.org - * Upstream app repository: https://github.com/q2a/question2answer - * YunoHost website: https://yunohost.org/ - ---- +* 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/question2answer_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/question2answer_ynh/tree/testing --debug or sudo yunohost app upgrade question2answer -u https://github.com/YunoHost-Apps/question2answer_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index e2c20e1..441a8db 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,72 +1,56 @@ + + # Question2Answer pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/question2answer.svg)](https://dash.yunohost.org/appci/app/question2answer) ![](https://ci-apps.yunohost.org/ci/badges/question2answer.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/question2answer.maintain.svg) -[![Installer question2answer avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=question2answer) +[![Niveau d'intégration](https://dash.yunohost.org/integration/question2answer.svg)](https://dash.yunohost.org/appci/app/question2answer) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/question2answer.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/question2answer.maintain.svg) +[![Installer Question2Answer avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=question2answer) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer Question2Answer rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Question2Answer 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 + Question2Answer (Q2A) est une plateforme de Questions/Réponses pour PHP/MySQL. -**Version incluse :** 1.8.6 + +**Version incluse :** 1.8.6~ynh2 + +**Démo :** http://demo.question2answer.org ## Captures d'écran -![](./images/install_screenshot) +![Capture d'écran de Question2Answer](./doc/screenshots/install_screenshot.png) -## Démo - -* [Démo officielle](http://demo.question2answer.org/) +## Avertissements / informations importantes ## Configuration Cette application se configure via son interface administrateur, accessible sur `https://mondomaine/monquestion2answer/index.php/admin/` -## Documentation - * Documentation officielle : https://www.question2answer.org/ - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. +## Documentations et ressources -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -Cette application supporte le multiutilisateur et LDAP, mais n'est pas intégrée avec le SSO. -Les pages d'administration sont protégées par SSOwat. - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/question2answer%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/question2answer/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/question2answer%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/question2answer/) - -## Limitations - -* Pas de limitations connues. - -## Informations additionnelles - -**Plus d'informations sur la page de documentation :** -https://yunohost.org/packaging_apps - -## Liens - - * Signaler un bug : https://github.com/nils-van-zuijlen/question2answer_ynh/issues - * Site de l'application : https://www.question2answer.org - * Dépôt de l'application principale : https://github.com/q2a/question2answer - * Site web YunoHost : https://yunohost.org/ - ---- +* 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/question2answer_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/question2answer_ynh/tree/testing --debug ou sudo yunohost app upgrade question2answer -u https://github.com/YunoHost-Apps/question2answer_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**