Merge pull request #8 from YunoHost-Apps/add-how-to

Add how to

README.md

@@ -38,6 +38,21 @@ Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg,
 
 ![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/>

README_fr.md

@@ -35,6 +35,21 @@ Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’
 
 ![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/>

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`

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`