2024-03-19 03:15:48 +01:00
|
|
|
|
{% if manifest.id == "example" -%}
|
|
|
|
|
# Packaging 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
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
{% endif -%}
|
|
|
|
|
|
2022-05-13 00:13:27 +02:00
|
|
|
|
<!--
|
2024-02-15 14:57:57 +01:00
|
|
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
|
2022-05-13 00:13:27 +02:00
|
|
|
|
It shall NOT be edited by hand.
|
|
|
|
|
-->
|
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
# {{manifest.name}} pour YunoHost
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
[ ![Niveau
|
|
|
|
|
d’intégration](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}})
|
|
|
|
|
![Statut du
|
|
|
|
|
fonctionnement](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg)
|
|
|
|
|
![Statut de
|
|
|
|
|
maintenance](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg)
|
2023-02-12 09:17:08 +01:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
[ ![[ ![Installer {{manifest.name}} avec
|
2024-03-19 03:15:48 +01:00
|
|
|
|
YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}})
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
*[Read this readme in english.](./README_fr.md)*
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
> *Ce package vous permet d’installer {{manifest.name}} 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.*
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## Vue d’ensemble
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 03:15:48 +01:00
|
|
|
|
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{%
|
2024-03-19 04:48:51 +01:00
|
|
|
|
endif %} **Version incluse :** {% if upstream.version %}{{upstream.version}}{%
|
2024-03-19 03:15:48 +01:00
|
|
|
|
else %}{{manifest.version}} {% endif -%}
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
{% if upstream.demo %} **Démo :** <{{upstream.demo}}> {% endif -%}
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2022-05-13 01:19:44 +02:00
|
|
|
|
{% if screenshots %}
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## Captures d’écran
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
{% for screenshot in screenshots -%} ![Capture d’écran de
|
2024-03-19 03:15:48 +01:00
|
|
|
|
{{manifest.name}}](./{{screenshot}}) {% endfor %} {% endif -%}
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2021-05-20 10:21:18 +02:00
|
|
|
|
{% if disclaimer -%}
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## Avertissements / informations importantes
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 03:15:48 +01:00
|
|
|
|
{{ disclaimer }} {% endif -%}
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2022-02-23 08:18:05 +01:00
|
|
|
|
{% if antifeatures -%}
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## :red_circle : Anti-fonctionnalités
|
2022-02-23 08:18:05 +01:00
|
|
|
|
|
2022-08-05 16:39:38 +02:00
|
|
|
|
{% for antifeature in antifeatures.values() -%}
|
2024-03-19 04:48:51 +01:00
|
|
|
|
- **{{ antifeature.title }}** : {{ antifeature.description }} {% endfor %} {%
|
2024-03-19 03:15:48 +01:00
|
|
|
|
endif -%}
|
2022-02-23 08:18:05 +01:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## Documentations et ressources
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
{% if upstream.website -%}- Site officiel de l’app : <{{ upstream.website }}> {%
|
|
|
|
|
endif -%} {% if upstream.userdoc -%}- Documentation officielle utilisateur : <{{
|
|
|
|
|
upstream.userdoc }}> {% endif -%} {% if upstream.admindoc -%}- Documentation
|
|
|
|
|
officielle de l’admin : <{{ upstream.admindoc }}> {% endif -%} {% if
|
|
|
|
|
upstream.code -%}- Dépôt de code officiel de l’app : <{{ upstream.code }}> {%
|
|
|
|
|
endif -%}
|
|
|
|
|
- YunoHost Store : <https://apps.yunohost.org/app/{{manifest.id}}>
|
|
|
|
|
- Signaler un bug :
|
|
|
|
|
<https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues>
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
## Informations pour les développeurs
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
Merci de faire vos pull request sur la [branche
|
|
|
|
|
testing](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing).
|
2021-04-23 20:01:40 +02:00
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
Pour essayer la branche testing, procédez comme suit.
|
2022-05-13 00:13:27 +02:00
|
|
|
|
|
2024-03-11 00:53:56 +01:00
|
|
|
|
```bash
|
2021-04-23 20:01:40 +02:00
|
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
2024-03-19 03:15:48 +01:00
|
|
|
|
or
|
2021-04-23 20:01:40 +02:00
|
|
|
|
sudo yunohost app upgrade {{manifest.id}} -u https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
|
|
|
|
```
|
|
|
|
|
|
2024-03-19 04:48:51 +01:00
|
|
|
|
**Plus d’infos sur le packaging d’applications :**
|
|
|
|
|
<https://yunohost.org/packaging_apps>
|
2024-03-07 00:59:01 +01:00
|
|
|
|
|