diff --git a/README.md b/README.md index b579fd4..dd64234 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,44 @@ + + # phpBB for YunoHost -* [phpBB](https://www.phpbb.com/) -* [YunoHost](https://yunohost.org/) +[![Integration level](https://dash.yunohost.org/integration/phpBB.svg)](https://dash.yunohost.org/appci/app/phpBB) ![](https://ci-apps.yunohost.org/ci/badges/phpBB.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpBB.maintain.svg) +[![Install phpBB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpBB) -## English +*[Lire ce readme en français.](./README_fr.md)* -phpBB is a free/libre open-source and gratis forum in [PHP](https://secure.php.net/) with nice responsive design. -This installation comes with both english and french translations. +> *This package allows you to install phpBB 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.* -Please note that the MySQL database and user created are both named "phpBB" (case sensitive). -The MySQL server address is "localhost" in standard. +## Overview -## Français +#1 free, opensource bulletin board software -phpBB est un forum en php libre et gratuit avec un design adaptatif. -Cette installation vient avec le pack français installé et disponible par défaut en plus de l'anglais. +**Shipped version:** 3.3.4~ynh1 -Veuillez noter que la base de donnée et l'utilisateur MySQL créés sont tous deux nommés "phpBB" (sensible à la casse). -L'adresse standard du serveur MySQL est "localhost". +**Demo:** https://demo.example.com + +## Documentation and resources + +* Official app website: https://example.com +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://yunohost.org/packaging_apps +* Upstream app code repository: https://some.forge.com/example/example +* YunoHost documentation for this app: https://yunohost.org/app_phpBB +* Report a bug: https://github.com/YunoHost-Apps/phpBB_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/phpBB_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/phpBB_ynh/tree/testing --debug +or +sudo yunohost app upgrade phpBB -u https://github.com/YunoHost-Apps/phpBB_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..41d776d --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# phpBB pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/phpBB.svg)](https://dash.yunohost.org/appci/app/phpBB) ![](https://ci-apps.yunohost.org/ci/badges/phpBB.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpBB.maintain.svg) +[![Installer phpBB avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpBB) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer phpBB 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 + +Le 1er logiciel de forum libre et gratuit + +**Version incluse :** 3.3.4~ynh1 + +**Démo :** https://demo.example.com + +## Documentations et ressources + +* Site officiel de l'app : https://example.com +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Dépôt de code officiel de l'app : https://some.forge.com/example/example +* Documentation YunoHost pour cette app : https://yunohost.org/app_phpBB +* Signaler un bug : https://github.com/YunoHost-Apps/phpBB_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phpBB_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/phpBB_ynh/tree/testing --debug +ou +sudo yunohost app upgrade phpBB -u https://github.com/YunoHost-Apps/phpBB_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file