diff --git a/README.md b/README.md index 6e5fbdc..a4354ce 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,48 @@ + + # Mindmaps for YunoHost -[![Integration level](https://dash.yunohost.org/integration/mindmaps.svg)](https://dash.yunohost.org/appci/app/mindmaps) ![](https://ci-apps.yunohost.org/ci/badges/mindmaps.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mindmaps.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/mindmaps.svg)](https://dash.yunohost.org/appci/app/mindmaps) ![Working status](https://ci-apps.yunohost.org/ci/badges/mindmaps.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mindmaps.maintain.svg) [![Install Mindmaps with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mindmaps) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Mindmaps quickly and simply on a YunoHost server. +> *This package allows you to install Mindmaps 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 + Mindmaps is a HTML5 based mind mapping application. It lets you create neat looking mind maps in the browser. -**Shipped version:** 20201010 + +**Shipped version:** 0.0.20201010~ynh2 + +**Demo:** https://www.mindmaps.app/ ## Screenshots -![](sources/mindmaps-screenshot.jpg) +![Screenshot of Mindmaps](./doc/screenshots/mindmaps-screenshot.jpg) -## Demo +## Documentation and resources -* [Official demo](https://www.mindmaps.app/) - -## Documentation - - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: https://yunohost.org/en/app_mindmaps - -## YunoHost specific features - -#### Multi-user support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mindmaps.svg)](https://ci-apps.yunohost.org/ci/apps/mindmaps/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mindmaps.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mindmaps/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/mindmaps_ynh/issues - * App website: https://www.mindmaps.app/ - * Upstream app repository: https://github.com/drichard/mindmaps - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing --debug or sudo yunohost app upgrade mindmaps -u https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index a0049e8..64ee8b3 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,67 +1,47 @@ + + # Mindmaps pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/mindmaps.svg)](https://dash.yunohost.org/appci/app/mindmaps) ![](https://ci-apps.yunohost.org/ci/badges/mindmaps.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mindmaps.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/mindmaps.svg)](https://dash.yunohost.org/appci/app/mindmaps) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mindmaps.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mindmaps.maintain.svg) [![Installer Mindmaps avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mindmaps) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d’installer Mindmaps 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.* +> *Ce package vous permet d'installer Mindmaps 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 -## Vue d’ensemble Mindmaps est une application de mind mapping basée sur HTML5. Il vous permet de créer des cartes mentales soignées dans le navigateur. -**Shipped version:** 20201010 +**Version incluse :** 0.0.20201010~ynh2 -## Captures d’écran +**Démo :** https://www.mindmaps.app/ -![](sources/mindmaps-screenshot.jpg) +## Captures d'écran -## Démo +![Capture d'écran de Mindmaps](./doc/screenshots/mindmaps-screenshot.jpg) -* [Démo officielle](https://www.mindmaps.app/) +## Documentations et ressources -## Documentation - - * Documentation officielle : Lien vers la documentation officielle de cette application. - * Documentation YunoHost : https://yunohost.org/fr/app_mindmaps - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mindmaps.svg)](https://ci-apps.yunohost.org/ci/apps/mindmaps/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mindmaps.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mindmaps/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/mindmaps_ynh/issues - * Site de l'application : https://www.mindmaps.app/ - * Dépôt de l'application principale : https://github.com/drichard/mindmaps - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing --debug -or +ou sudo yunohost app upgrade mindmaps -u https://github.com/YunoHost-Apps/mindmaps_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**