diff --git a/README.md b/README.md index 795eb92..4d4dfda 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,42 @@ + + # COPS for YunoHost -[![Integration level](https://dash.yunohost.org/integration/cops.svg)](https://dash.yunohost.org/appci/app/cops) ![](https://ci-apps.yunohost.org/ci/badges/cops.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cops.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/cops.svg)](https://dash.yunohost.org/appci/app/cops) ![](https://ci-apps.yunohost.org/ci/badges/cops.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cops.maintain.svg) +[![Install COPS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cops) -* You need to indicate the true path of your calibre library and make sure COPS runs under the same user as were the files are located +*[Lire ce readme en français.](./README_fr.md)* -* Designed to work best with OwnCloud or NextCloud +> *This package allows you to install COPS 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.* -* Creates an OPDS and HTML server based on a Calibre folder stored in Owncloud or NextCloud +## Overview -Packaged version : 1.0.1 +Calibre OPDS (and HTML) PHP Server - * Report a bug: https://github.com/YunoHost-Apps/cops_ynh/issues - * App website: http://blog.slucas.fr/fr/oss/calibre-opds-php-server - * Upstream app repository: https://github.com/seblucas/cops - * YunoHost website: https://yunohost.org/ +**Shipped version:** + +**Demo:** http://cops-demo.slucas.fr/index.php + +## Documentation and resources + +* Official app website: https://blog.slucas.fr/projects/calibre-opds-php-server/ +* Upstream app code repository: https://github.com/seblucas/cops +* YunoHost documentation for this app: https://yunohost.org/app_cops +* Report a bug: https://github.com/YunoHost-Apps/cops_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cops_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug +or +sudo yunohost app upgrade cops -u https://github.com/YunoHost-Apps/cops_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..e206de6 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,38 @@ +# COPS pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/cops.svg)](https://dash.yunohost.org/appci/app/cops) ![](https://ci-apps.yunohost.org/ci/badges/cops.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cops.maintain.svg) +[![Installer COPS avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cops) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer COPS 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 + +Calibre OPDS (et HTML) PHP Serveur + +**Version incluse :** + +**Démo :** http://cops-demo.slucas.fr/index.php + +## Documentations et ressources + +* Site officiel de l'app : https://blog.slucas.fr/projects/calibre-opds-php-server/ +* Dépôt de code officiel de l'app : https://github.com/seblucas/cops +* Documentation YunoHost pour cette app : https://yunohost.org/app_cops +* Signaler un bug : https://github.com/YunoHost-Apps/cops_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/cops_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug +ou +sudo yunohost app upgrade cops -u https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file