Merge pull request #9 from YunoHost-Apps/testing

Testing
2024-09-03 19:35:56 +02:00 · 2022-07-01 16:03:14 +02:00 · 2022-07-01 16:03:14 +02:00 · 8812c894a1
commit 8812c894a1
parent e7e2712ff7 ca9078cf1e
5 changed files with 82 additions and 22 deletions
--- 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)*
@ -30,31 +30,47 @@ Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg,
 - RESTful API endpoint with OPDS (XML)


-**Shipped version:** 3.1.2~ynh1
+**Shipped version:** 3.1.2~ynh2

 **Demo:** http://library.kiwix.org/

 ## 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: <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>

 ## 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
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,10 +1,14 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # 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.*
@ -23,31 +27,47 @@ Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’
 - Embedded in Kiwix UI
 - Capable de traiter un fichier ZIM ou des fichiers de bibliothèque XML

-**Version incluse :** 3.1.2~ynh1
+**Version incluse :** 3.1.2~ynh2

 **Démo :** http://library.kiwix.org/

 ## 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 : <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>

 ## 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
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@ -0,0 +1,12 @@
+### 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`
--- a/doc/DISCLAIMER_fr.md
+++ b/doc/DISCLAIMER_fr.md
@ -0,0 +1,12 @@
+### 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`
--- a/manifest.json
+++ b/manifest.json
@ -6,7 +6,7 @@
        "en": "Sharing Web content with people without Internet access",
        "fr": "Partager du contenu Web avec des personnes sans accès à Internet"
    },
-    "version": "3.1.2~ynh1",
+    "version": "3.1.2~ynh2",
    "url": "https://www.kiwix.org/",
    "upstream": {
        "license": "GPL-3.0-or-later",