diff --git a/README.md b/README.md index e9305bd..10d3aa3 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,42 @@ + + # Libreto for YunoHost [![Integration level](https://dash.yunohost.org/integration/libreto.svg)](https://dash.yunohost.org/appci/app/libreto) ![](https://ci-apps.yunohost.org/ci/badges/libreto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/libreto.maintain.svg) [![Install Libreto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreto) -> *This package allow you to install Libreto 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 Libreto 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 -Libreto let you aggregate your pad (Etherpad lite) to create a kind of wiki easily. -**Shipped version:** 0.0.20180605 +Aggregate your pads to create a wiki. + +**Shipped version:** 0.0.20180605~ynh2 + +**Demo:** https://libreto.net ## Screenshots -![Home page of Libreto](img/home.png) -![Usage of Libreto](img/menu.png) +![](./doc/screenshots/home.png) +![](./doc/screenshots/menu.png) -## Demo +## Documentation and resources -* [Official demo](https://libreto.net) +* Official app website: https://libreto.net +* Official admin documentation: https://github.com/Ventricule/libreto +* Upstream app code repository: https://github.com/Ventricule/libreto +* YunoHost documentation for this app: https://yunohost.org/app_libreto +* Report a bug: https://github.com/YunoHost-Apps/libreto_ynh/issues -## Configuration +## Developer info -No configuration needed. - -## Documentation - - * Official documentation: https://github.com/Ventricule/libreto - -## YunoHost specific features - -#### Multi-users support - -Libreto has no user management, but YunoHost allow you to decide if this app is public or not. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/libreto.svg)](https://ci-apps.yunohost.org/ci/apps/libreto/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/libreto.svg)](https://ci-apps-arm.yunohost.org/ci/apps/libreto/) - -## Limitations - -Only app instances with a valid certificate and allowing to be included in Frame could be used. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/libreto_ynh/issues - * App website: http://libreto.net/ - * Upstream app repository: https://github.com/Ventricule/libreto - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/libreto_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/libreto_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -62,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/libreto_ynh/tree/test or sudo yunohost app upgrade libreto -u https://github.com/YunoHost-Apps/libreto_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..21867bf --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# Libreto pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/libreto.svg)](https://dash.yunohost.org/appci/app/libreto) ![](https://ci-apps.yunohost.org/ci/badges/libreto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/libreto.maintain.svg) +[![Installer Libreto avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreto) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Libreto 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 + +Agrégez vos pads pour créer un wiki. + +**Version incluse :** 0.0.20180605~ynh2 + +**Démo :** https://libreto.net + +## Captures d'écran + +![](./doc/screenshots/home.png) +![](./doc/screenshots/menu.png) + +## Documentations et ressources + +* Site officiel de l'app : https://libreto.net +* Documentation officielle de l'admin : https://github.com/Ventricule/libreto +* Dépôt de code officiel de l'app : https://github.com/Ventricule/libreto +* Documentation YunoHost pour cette app : https://yunohost.org/app_libreto +* Signaler un bug : https://github.com/YunoHost-Apps/libreto_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/libreto_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/libreto_ynh/tree/testing --debug +ou +sudo yunohost app upgrade libreto -u https://github.com/YunoHost-Apps/libreto_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file