diff --git a/README.md b/README.md index 96dd895..b325390 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # HedgeDoc for YunoHost [![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) @@ -5,56 +10,36 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install HedgeDoc 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.* +> *This package allows you to install HedgeDoc 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 -HedgeDoc ([formerly known as CodiMD](https://hedgedoc.org/history/)) is an open-source collaborative markdown editor. With HedgeDoc you can easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers, and they’re ready to go. -**Shipped version:** 1.8.2 +Collaborative editor to work on notes written in Markdown + +**Shipped version:** 1.8.2~ynh1 + +**Demo:** https://demo.hedgedoc.org/ ## Screenshots -![](https://demo.hedgedoc.org/screenshot.png) +![](./doc/screenshots/screenshot.png) -## Demo - -* [Official demo](https://demo.hedgedoc.org/) +## Disclaimers / important information ## Configuration You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`. -## Documentation +## Documentation and resources - * Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs - * YunoHost documentation: https://yunohost.org/en/app_hedgedoc - -## YunoHost specific features - -#### Multi-user support - -* Is LDAP supported? **Yes** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps.yunohost.org/ci/apps/hedgedoc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hedgedoc/) - -## Limitations - -* HedgeDoc needs more than 3 GB of RAM to build. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues - * App website: https://hedgedoc.org - * Upstream app repository: https://github.com/hedgedoc/hedgedoc - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://hedgedoc.org +* Official user documentation: https://yunohost.org/en/app_hedgedoc +* Official admin documentation: https://docs.hedgedoc.org/ +* Upstream app code repository: https://github.com/hedgedoc/hedgedoc +* YunoHost documentation for this app: https://yunohost.org/app_hedgedoc +* Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues ## Developer info @@ -66,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/tes or sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_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 f457c58..289e89a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,58 +3,39 @@ [![Niveau d'intégration](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) [![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) -*[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 HedgeDoc 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 HedgeDoc 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 -HedgeDoc ([anciennement connu sous le nom de CodiMD](https://hedgedoc.org/history/)) est un éditeur Markdown collaboratif open-source. Avec HedgeDoc, vous pouvez facilement collaborer sur des notes, des graphiques et même des présentations en temps réel. Tout ce que vous avez à faire est de partager votre lien de note avec vos collègues. -**Version incluse :** 1.8.2 +Éditeur collaboratif pour travailler sur des notes en Markdown + +**Version incluse :** 1.8.2~ynh1 + +**Démo :** https://demo.hedgedoc.org/ ## Captures d'écran -![](https://demo.hedgedoc.org/screenshot.png) +![](./doc/screenshots/screenshot.png) -## Démo - -* [Démo officielle](https://demo.hedgedoc.org/) +## Avertissements / informations importantes ## Configuration Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/hedgedoc/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`. -## Documentation +## Documentations et ressources - * Documentation officielle : https://github.com/hedgedoc/hedgedoc/tree/master/docs - * Documentation YunoHost : https://yunohost.org/fr/app_hedgedoc - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP est-elle prise en charge ? **Oui** -* 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/hedgedoc.svg)](https://ci-apps.yunohost.org/ci/apps/hedgedoc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hedgedoc/) - -## Limitations - -* HedgeDoc a besoin de plus de 3 Go de RAM pour être installé. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues - * Site de l'application : https://hedgedoc.org - * Dépôt de l'application principale : https://github.com/hedgedoc/hedgedoc - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://hedgedoc.org +* Documentation officielle utilisateur : https://yunohost.org/en/app_hedgedoc +* Documentation officielle de l'admin : https://docs.hedgedoc.org/ +* Dépôt de code officiel de l'app : https://github.com/hedgedoc/hedgedoc +* Documentation YunoHost pour cette app : https://yunohost.org/app_hedgedoc +* Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues ## Informations pour les développeurs @@ -66,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/tes ou sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file