From 7303c70c708e7c0be576cab0cd498f0372988734 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 29 Jun 2022 08:05:14 +0000 Subject: [PATCH] Auto-update README --- README.md | 34 +++++++++++++++++++++++++--------- README_fr.md | 40 ++++++++++++++++++++++++++++++---------- 2 files changed, 55 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e67cb73..cda8786 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Kiwix for YunoHost -[![Integration level](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![Working status](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) [![Install Kiwix with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix) *[Lire ce readme en français.](./README_fr.md)* @@ -36,25 +36,41 @@ Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg, ## Screenshots -![](./doc/screenshots/screenshot.png) +![Screenshot of Kiwix](./doc/screenshots/screenshot.png) + +## Disclaimers / important information + +### How to add zim files? + +- Download one or more ZIM files, e.g. from [https://download.kiwix.org/zim/](https://download.kiwix.org/zim/) +- Put the ZIM files into `/home/yunohost.app/kiwix/` +- Add them to the library with the following command: +``` +/var/www/kiwix/kiwix-manage /home/yunohost.app/kiwix/library.xml add /home/yunohost.app/kiwix/*.zim +``` + +- Restart the service: + +`yunohost service restart kiwix` ## Documentation and resources -* Official app website: https://www.kiwix.org/ -* Official admin documentation: https://wiki.kiwix.org/wiki/Kiwix-serve/ -* Upstream app code repository: https://github.com/kiwix/kiwix-tools -* YunoHost documentation for this app: https://yunohost.org/app_kiwix -* Report a bug: https://github.com/YunoHost-Apps/kiwix_ynh/issues +* Official app website: +* Official admin documentation: +* 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/kiwix_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug or sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 9839fcf..420ad0a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Kiwix pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) [![Installer Kiwix avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Kiwix 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.* @@ -29,25 +33,41 @@ Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’ ## Captures d'écran -![](./doc/screenshots/screenshot.png) +![Capture d'écran de Kiwix](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes + +### Comment ajouter des fichiers ZIM ? + +- Téléchargez un ou plusieurs fichiers ZIM, par ex. [https://download.kiwix.org/zim/](https://download.kiwix.org/zim/) +- Mettez les fichiers ZIM dans `/home/yunohost.app/kiwix/` +- Ajoutez-les à la bibliothèque avec la commande suivante : +``` +/var/www/kiwix/kiwix-manage /home/yunohost.app/kiwix/library.xml add /home/yunohost.app/kiwix/*.zim +``` + +- Redémarrez le service : + +`yunohost service restart kiwix` ## Documentations et ressources -* Site officiel de l'app : https://www.kiwix.org/ -* Documentation officielle de l'admin : https://wiki.kiwix.org/wiki/Kiwix-serve/ -* Dépôt de code officiel de l'app : https://github.com/kiwix/kiwix-tools -* Documentation YunoHost pour cette app : https://yunohost.org/app_kiwix -* Signaler un bug : https://github.com/YunoHost-Apps/kiwix_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* 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/kiwix_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug ou sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**