mirror of
https://github.com/YunoHost-Apps/kiwix_ynh.git
synced 2024-09-03 19:35:56 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
b75407dee9
commit
049be018d8
2 changed files with 56 additions and 63 deletions
65
README.md
65
README.md
|
|
@ -1,48 +1,42 @@
|
|||
|
||||
# Packaging your an app, starting from this example
|
||||
|
||||
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
- Edit the `manifest.json` with app specific info.
|
||||
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
||||
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||
- Add a `LICENSE` file for the package.
|
||||
- Edit `doc/DISCLAIMER*.md`
|
||||
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Kiwix for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/kiwix)  
|
||||
[](https://install-app.yunohost.org/?app=kiwix)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install example quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Kiwix 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
|
||||
|
||||
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
|
||||
Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg, or TED Talks. It makes knowledge available to people with no or limited internet access. The software as well as the content is free to use for anyone.
|
||||
|
||||
**Shipped version:** 1.0~ynh1
|
||||
### Features
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
- Full text search engine
|
||||
- Search suggestions
|
||||
- Really small and efficient
|
||||
- Compatible with almost all browsers
|
||||
- Available on all platforms
|
||||
- Available as command line executable
|
||||
- Embedded in Kiwix UI
|
||||
- Able to deal with one ZIM file or XML library files
|
||||
- RESTful API endpoint with OPDS (XML)
|
||||
|
||||
|
||||
**Shipped version:** 3.1.2~ynh1
|
||||
|
||||
**Demo:** http://library.kiwix.org/
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
|
|
@ -59,26 +53,23 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
|
|||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
|
||||
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: https://example.com
|
||||
* Official user documentation: https://yunohost.org/apps
|
||||
* Official admin documentation: https://yunohost.org/packaging_apps
|
||||
* Upstream app code repository: https://some.forge.com/example/example
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_example
|
||||
* Report a bug: https://github.com/YunoHost-Apps/example_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
|
||||
* 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/example_ynh/tree/testing).
|
||||
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.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
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
|
||||
54
README_fr.md
54
README_fr.md
|
|
@ -1,30 +1,35 @@
|
|||
# Example app pour YunoHost
|
||||
# Kiwix pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/kiwix)  
|
||||
[](https://install-app.yunohost.org/?app=kiwix)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install example 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.*
|
||||
> *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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
|
||||
Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’accéder à Wikipédia sans connexion à Internet.
|
||||
|
||||
**Version incluse:** 1.0~ynh1
|
||||
### Fonctionnalités
|
||||
- Un moteur de recherche de tout texte
|
||||
- Suggestions de recherche
|
||||
- Réellement petit et efficace
|
||||
- Compatible avec la majorité des navigateurs internet
|
||||
- Disponible avec toutes les plateformes
|
||||
- Disponible par ligne de commande exécutables
|
||||
- Embedded in Kiwix UI
|
||||
- Capable de traiter un fichier ZIM ou des fichiers de bibliothèque XML
|
||||
|
||||
**Démo:** https://demo.example.com
|
||||
**Version incluse :** 3.1.2~ynh1
|
||||
|
||||
**Démo :** http://library.kiwix.org/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
|
|
@ -41,26 +46,23 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
|
|||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site official de l'app : https://example.com
|
||||
* Documentation officielle utilisateur: https://yunohost.org/apps
|
||||
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
|
||||
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/example_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
|
||||
* 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/example_ynh/tree/testing).
|
||||
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.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
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
|
||||
Loading…
Add table
Reference in a new issue