diff --git a/README.md b/README.md index ecfaac3..1909b9a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # YesWiki for YunoHost [![Integration level](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg) @@ -5,8 +10,8 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install YesWiki 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.* +> *This package allows you to install YesWiki 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 @@ -19,26 +24,16 @@ However, with a YesWiki we can build a website with multiple uses: - Communicate information flows - Cultivate a bit of freedom... -**Shipped version:** Doryphore 2021-08-17-1 + +**Shipped version:** 2021.11.04~ynh1 + +**Demo:** https://ferme.yeswiki.net/?CreerSonWiki ## Screenshots -![](/images/yeswiki_screenshots.png) +![](./doc/screenshots/yeswiki_screenshots.png) -## Demo - -* [Official demo](https://ferme.yeswiki.net/?CreerSonWiki) - -## Configuration - -Configure the application via YesWiki. - -## Documentation - -* Official documentation: https://yeswiki.net/?DocumentatioN -* YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features +## Disclaimers / important information #### Multi-users support @@ -46,36 +41,23 @@ LDAP integration is supported and required on new installs. It is possible to di At the moment SSO authentication is not supported. It is necessary to login on the wiki. -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps.yunohost.org/ci/apps/yeswiki/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yeswiki/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other information you would add about this application - -## Links +## Documentation and resources +* Official app website: https://yeswiki.net/ +* Official admin documentation: https://yeswiki.net/?DocumentatioN +* Upstream app code repository: https://github.com/YesWiki/yeswiki +* YunoHost documentation for this app: https://yunohost.org/app_yeswiki * Report a bug: https://github.com/YunoHost-Apps/yeswiki_ynh/issues -* App website: https://yeswiki.net/?AccueiL -* Upstream app repository: https://github.com/YesWiki/yeswiki -* YunoHost website: https://yunohost.org/ ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing). To try the testing branch, please proceed like that. - ``` sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug or sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_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 195672b..11e767f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -4,9 +4,10 @@ [![Installer YesWiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yeswiki) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer YesWiki 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.* +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble @@ -19,26 +20,16 @@ Néanmoins, avec un YesWiki on peut fabriquer un site internet aux usages multip - Faire communiquer des flux d'informations - Cultiver un bout de liberté... -**Version incluse :** Doryphore 2021-08-17-1 + +**Version incluse :** 2021.11.04~ynh1 + +**Démo :** https://ferme.yeswiki.net/?CreerSonWiki ## Captures d'écran -![](/images/yeswiki_screenshots.png) +![](./doc/screenshots/yeswiki_screenshots.png) -## Démo - -* [Démo officielle](https://ferme.yeswiki.net/?CreerSonWiki) - -## Configuration - -Configurer l'application via YesWiki. - -## Documentation - - * Documentation officielle : https://yeswiki.net/?DocumentatioN - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost +## Avertissements / informations importantes #### Support multi-utilisateurs @@ -46,27 +37,13 @@ L'intégration au LDAP est la seule méthode supportée pour les nouvelles insta Pour le moment l'authentification SSO n'est pas prise en charge. Il est nécessaire de se connecter sur le wiki. -#### Architectures supportées +## Documentations et ressources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps.yunohost.org/ci/apps/yeswiki/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yeswiki/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations à ajouter sur cette application - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/yeswiki_ynh/issues - * Site de l'application : https://yeswiki.net/?AccueiL - * Dépôt de l'application principale : https://github.com/YesWiki/yeswiki - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://yeswiki.net/ +* Documentation officielle de l'admin : https://yeswiki.net/?DocumentatioN +* Dépôt de code officiel de l'app : https://github.com/YesWiki/yeswiki +* Documentation YunoHost pour cette app : https://yunohost.org/app_yeswiki +* Signaler un bug : https://github.com/YunoHost-Apps/yeswiki_ynh/issues ## Informations pour les développeurs @@ -78,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/test ou sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file