diff --git a/README.md b/README.md index 531af39..609f206 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,53 @@ + + # DotClear 2 for YunoHost -[![Integration level](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg) -[![Install dotclear2 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=dotclear2) +[![Integration level](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg) +[![Install DotClear 2 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dotclear2) -> *This package allow you to install dotclear2 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 DotClear 2 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 -Dotclear is an open-source web publishing software. -**Shipped version:** 2.20.1 +Blog publishing application + +**Shipped version:** 2.20.1~ynh2 + +**Demo:** https://www.softaculous.com/demos/Dotclear ## Screenshots -![](https://installatron.com/images/remote/ss2_dotclear.png) +![](./doc/screenshots/ss2_dotclear.png) -## Demo - -* [Official demo](https://www.softaculous.com/demos/Dotclear) +## Disclaimers / important information ## Configuration How to configure this app: by an admin panel. -## Documentation - - * Official documentation: https://dotclear.org/documentation/2.0 - -## YunoHost specific features - #### Multi-users support Are LDAP supported? **Yes** Are HTTP auth supported? **No** (PR are welcome!) Can the app be used by multiple users? **Yes** -#### Supported architectures +## Documentation and resources -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/dotclear2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/dotclear2/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/dotclear2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/dotclear2/) +* Official app website: https://dotclear.org +* Official admin documentation: https://dotclear.org/documentation/2.0 +* Upstream app code repository: https://git.dotclear.org/dev/dotclear +* YunoHost documentation for this app: https://yunohost.org/app_dotclear2 +* Report a bug: https://github.com/YunoHost-Apps/dotclear2_ynh/issues -## Limitations +## Developer info -* Only YunoHost users can have an admin account. (PR are welcome!) - -**More information on the documentation page:** -https://yunohost.org/packaging_apps - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/dotclear2_ynh/issues - * App website: https://dotclear.org - * Upstream app repository: https://git.dotclear.org/dev/dotclear - * YunoHost website: https://yunohost.org/ - ---- - -Developers info ----------------- - -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -68,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/dotclear2_ynh/tree/te or sudo yunohost app upgrade dotclear2 -u https://github.com/YunoHost-Apps/dotclear2_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..9745b61 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,55 @@ +# DotClear 2 pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg) +[![Installer DotClear 2 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dotclear2) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer DotClear 2 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 + +Moteur de blog + +**Version incluse :** 2.20.1~ynh2 + +**Démo :** https://www.softaculous.com/demos/Dotclear + +## Captures d'écran + +![](./doc/screenshots/ss2_dotclear.png) + +## Avertissements / informations importantes + +## Configuration + +How to configure this app: by an admin panel. + +#### Multi-users support + +Are LDAP supported? **Yes** +Are HTTP auth supported? **No** (PR are welcome!) +Can the app be used by multiple users? **Yes** + +## Documentations et ressources + +* Site officiel de l'app : https://dotclear.org +* Documentation officielle de l'admin : https://dotclear.org/documentation/2.0 +* Dépôt de code officiel de l'app : https://git.dotclear.org/dev/dotclear +* Documentation YunoHost pour cette app : https://yunohost.org/app_dotclear2 +* Signaler un bug : https://github.com/YunoHost-Apps/dotclear2_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug +ou +sudo yunohost app upgrade dotclear2 -u https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file