diff --git a/README.md b/README.md index 83ec260..e81ece2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Lychee for YunoHost [![Integration level](https://dash.yunohost.org/integration/lychee.svg)](https://dash.yunohost.org/appci/app/lychee) ![](https://ci-apps.yunohost.org/ci/badges/lychee.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/lychee.maintain.svg) @@ -5,59 +10,29 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Lychee quickly and simply on a YunoHost server. +> *This package allows you to install Lychee 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 -Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely. -**Shipped version:** 4.3 +Photo-management-system to manage and share photos. + +**Shipped version:** 4.3~ynh2 + +**Demo:** https://lycheeorg.github.io/demo/ ## Screenshots -![](https://camo.githubusercontent.com/b9010f02c634219795950e034f511f4cf4af5c60/68747470733a2f2f732e656c6563746572696f75732e636f6d2f696d616765732f6c79636865652f312e6a706567) +![](./doc/screenshots/screenshot.jpg) -## Demo +## Documentation and resources -* [Official demo](https://lycheeorg.github.io/demo/) - -## Configuration - -How to configure this app: From an admin panel. - -## Documentation - - * Official documentation: https://lycheeorg.github.io/docs/ - * YunoHost documentation: https://yunohost.org/en/app_lychee - -## 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/lychee.svg)](https://ci-apps.yunohost.org/ci/apps/lychee/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/lychee.svg)](https://ci-apps-arm.yunohost.org/ci/apps/lychee/) - -## 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/lychee_ynh/issues - * App website: https://lycheeorg.github.io/ - * Upstream app repository: https://github.com/LycheeOrg/Lychee - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://lycheeorg.github.io/ +* Official user documentation: https://yunohost.org/en/app_lychee +* Official admin documentation: https://lycheeorg.github.io/docs/ +* Upstream app code repository: https://github.com/LycheeOrg/Lychee +* YunoHost documentation for this app: https://yunohost.org/app_lychee +* Report a bug: https://github.com/YunoHost-Apps/lychee_ynh/issues ## Developer info @@ -69,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/lychee_ynh/tree/testi or sudo yunohost app upgrade lychee -u https://github.com/YunoHost-Apps/lychee_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 3ec9d46..bee77f0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,63 +1,34 @@ # Lychee pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/lychee.svg)](https://dash.yunohost.org/appci/app/lychee) ![](https://ci-apps.yunohost.org/ci/badges/lychee.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/lychee.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/lychee.svg)](https://dash.yunohost.org/appci/app/lychee) ![](https://ci-apps.yunohost.org/ci/badges/lychee.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/lychee.maintain.svg) [![Installer Lychee avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lychee) -*[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 Lychee 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 Lychee 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 -Lychee est un outil de gestion de photos gratuit, qui fonctionne sur votre serveur ou votre espace Web. L'installation est une question de secondes. Téléchargez, gérez et partagez des photos comme à partir d'une application native. Lychee est livré avec tout ce dont vous avez besoin et toutes vos photos sont stockées en toute sécurité. -**Version incluse :** 4.3 +Système de gestion de photos pour gérer et partager des photos. + +**Version incluse :** 4.3~ynh2 + +**Démo :** https://lycheeorg.github.io/demo/ ## Captures d'écran -![](https://camo.githubusercontent.com/b9010f02c634219795950e034f511f4cf4af5c60/68747470733a2f2f732e656c6563746572696f75732e636f6d2f696d616765732f6c79636865652f312e6a706567) +![](./doc/screenshots/screenshot.jpg) -## Démo +## Documentations et ressources -* [Démo officielle](https://lycheeorg.github.io/demo/) - -## Configuration - -Comment configurer cette application : via le panneau d'administration. - -## Documentation - - * Documentation officielle : https://lycheeorg.github.io/docs/ - * Documentation YunoHost : https://yunohost.org/fr/app_lychee - -## 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/lychee.svg)](https://ci-apps.yunohost.org/ci/apps/lychee/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/lychee.svg)](https://ci-apps-arm.yunohost.org/ci/apps/lychee/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/lychee_ynh/issues - * Site de l'application : https://lycheeorg.github.io/ - * Dépôt de l'application principale : https://github.com/LycheeOrg/Lychee - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://lycheeorg.github.io/ +* Documentation officielle utilisateur : https://yunohost.org/en/app_lychee +* Documentation officielle de l'admin : https://lycheeorg.github.io/docs/ +* Dépôt de code officiel de l'app : https://github.com/LycheeOrg/Lychee +* Documentation YunoHost pour cette app : https://yunohost.org/app_lychee +* Signaler un bug : https://github.com/YunoHost-Apps/lychee_ynh/issues ## Informations pour les développeurs @@ -66,6 +37,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/lychee_ynh/tree/testing --debug -or +ou sudo yunohost app upgrade lychee -u https://github.com/YunoHost-Apps/lychee_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file