diff --git a/README.md b/README.md index dfc669e..007640a 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,36 @@ + + # ChuWiki for YunoHost [![Integration level](https://dash.yunohost.org/integration/chuwiki.svg)](https://dash.yunohost.org/appci/app/chuwiki) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.maintain.svg) -[![Install chuwiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki) +[![Install ChuWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install ChuWiki quickly and simply on a YunoHost server. +> *This package allows you to install ChuWiki 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 + A simple, fast and flexible wiki. -**Shipped version:** 2.0 +**Shipped version:** 2.0~ynh1 -## Configuration -How to configure this app: via the `configuration.ini` file. -## Documentation +## Documentation and resources - * Official documentation: http://chuwiki.genezys.net/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - -Are LDAP and HTTP auth supported? Yes. -Can the app be used by multiple users? Yes, but it is not specific to YunoHost but to the app. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chuwiki/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chuwiki/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/chuwiki_ynh/issues - * App website: http://chuwiki.genezys.net/ - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: http://chuwiki.genezys.net/ +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: http://chuwiki.genezys.net/ +* YunoHost documentation for this app: https://yunohost.org/app_chuwiki +* Report a bug: https://github.com/YunoHost-Apps/chuwiki_ynh/issues ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing). To try the testing branch, please proceed like that. @@ -53,3 +39,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/chuwiki_ynh/tree/test or sudo yunohost app upgrade chuwiki -u https://github.com/YunoHost-Apps/chuwiki_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 index beaedd0..545a29c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,50 +1,32 @@ # ChuWiki pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/chuwiki.svg)](https://dash.yunohost.org/appci/app/chuwiki) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.maintain.svg) -[![Installer chuwiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki) +[![Installer ChuWiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer ChuWiki 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 ChuWiki 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 + Un wiki simple, rapide et flexible. -**Version incluse :** 2.0 +**Version incluse :** 2.0~ynh1 -## Configuration -Comment configurer cette application : via le fichier `configuration.ini`. -## Documentation +## Documentations et ressources - * Documentation officielle : http://chuwiki.genezys.net/ - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? Oui. -* L'application peut-elle être utilisée par plusieurs utilisateurs ? Oui, mais cela n'est pas spécifique a YunoHost mais a l'app. - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chuwiki/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chuwiki/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/chuwiki_ynh/issues - * Site de l'application : http://chuwiki.genezys.net/ - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : http://chuwiki.genezys.net/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : http://chuwiki.genezys.net/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_chuwiki +* Signaler un bug : https://github.com/YunoHost-Apps/chuwiki_ynh/issues ## Informations pour les développeurs -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. @@ -53,3 +35,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/chuwiki_ynh/tree/test ou sudo yunohost app upgrade chuwiki -u https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file