diff --git a/README.md b/README.md index 398361c..36a95d6 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,42 @@ + + # My Mind for YunoHost [![Integration level](https://dash.yunohost.org/integration/my-mind.svg)](https://dash.yunohost.org/appci/app/my-mind) ![](https://ci-apps.yunohost.org/ci/badges/my-mind.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/my-mind.maintain.svg) [![Install My Mind with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my-mind) -> *This package allow you to install My Mind 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 My Mind 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 -My Mind is a web application for creating and managing Mind maps. It is free to use and you can fork its source code. It is distributed under the terms of the MIT license. -New to mind maps? They are useful, aesthetic and cool! Read more about these special diagrams in [the Wikipedia article](http://en.wikipedia.org/wiki/Mind_map). -**Shipped version:** 1.2 +Online Mindmapping Software + +**Shipped version:** 1.2~ynh3 + +**Demo:** http://my-mind.github.io/?map=examples/features.mymind ## Screenshots -![](https://github.com/ondras/my-mind/blob/master/screenshot.png) +![](./doc/screenshots/screenshot.png) -## Demo +## Documentation and resources -* [Official demo](http://my-mind.github.io/?map=examples/features.mymind) +* Official app website: https://github.com/ondras/my-mind +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://github.com/ondras/my-mind/wiki +* Upstream app code repository: https://github.com/ondras/my-mind +* YunoHost documentation for this app: https://yunohost.org/app_my-mind +* Report a bug: https://github.com/YunoHost-Apps/my-mind_ynh/issues -## Documentation +## Developer info - * Official documentation: https://github.com/ondras/my-mind/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## 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/my-mind.svg)](https://ci-apps.yunohost.org/ci/apps/my-mind/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/my-mind.svg)](https://ci-apps-arm.yunohost.org/ci/apps/my-mind/) - -## 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/my-mind_ynh/issues - * App website: http://my-mind.github.io/ - * Upstream app repository: https://github.com/ondras/my-mind - * YunoHost website: https://yunohost.org/ - ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/my-mind_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/my-mind_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -64,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/my-mind_ynh/tree/test or sudo yunohost app upgrade my-mind -u https://github.com/YunoHost-Apps/my-mind_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..9a8e0d5 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# My Mind pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/my-mind.svg)](https://dash.yunohost.org/appci/app/my-mind) ![](https://ci-apps.yunohost.org/ci/badges/my-mind.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/my-mind.maintain.svg) +[![Installer My Mind avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my-mind) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer My Mind 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 + +Éditeur de cartes mentales + +**Version incluse :** 1.2~ynh3 + +**Démo :** http://my-mind.github.io/?map=examples/features.mymind + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Documentations et ressources + +* Site officiel de l'app : https://github.com/ondras/my-mind +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://github.com/ondras/my-mind/wiki +* Dépôt de code officiel de l'app : https://github.com/ondras/my-mind +* Documentation YunoHost pour cette app : https://yunohost.org/app_my-mind +* Signaler un bug : https://github.com/YunoHost-Apps/my-mind_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/my-mind_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/my-mind_ynh/tree/testing --debug +ou +sudo yunohost app upgrade my-mind -u https://github.com/YunoHost-Apps/my-mind_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file