1
0
Fork 0
ynh-apps_tools/readme_generator/templates/README_fr.md.j2

94 lines
3.3 KiB
Text
Raw Normal View History

{% 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
<!--
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.
-->
# {{manifest.name}} for YunoHost
2021-04-23 20:01:40 +02:00
[![Integration
level](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}})
![Working
status](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg)
![Maintenance
status](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg)
2023-02-12 09:17:08 +01:00
[![Install {{manifest.name}} with
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
*[Lire ce readme en français.](./README_fr.md)*
2021-04-23 20:01:40 +02:00
> *This package allows you to install {{manifest.name}} 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.*
2021-04-23 20:01:40 +02:00
## Overview
2021-04-23 20:01:40 +02:00
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{%
endif %} **Shipped version:** {% if upstream.version %}{{upstream.version}}{%
else %}{{manifest.version}} {% endif -%}
2021-04-23 20:01:40 +02:00
{% if upstream.demo %} **Demo:** <{{upstream.demo}}> {% endif -%}
2021-04-23 20:01:40 +02:00
2022-05-13 01:19:44 +02:00
{% if screenshots %}
## Screenshots
2021-04-23 20:01:40 +02:00
{% for screenshot in screenshots -%} ![Screenshot of
{{manifest.name}}](./{{screenshot}}) {% endfor %} {% endif -%}
2021-04-23 20:01:40 +02:00
{% if disclaimer -%}
## Disclaimers / important information
2021-04-23 20:01:40 +02:00
{{ disclaimer }} {% endif -%}
2021-04-23 20:01:40 +02:00
2022-02-23 08:18:05 +01:00
{% if antifeatures -%}
## :red_circle: Antifeatures
2022-02-23 08:18:05 +01:00
2022-08-05 16:39:38 +02:00
{% for antifeature in antifeatures.values() -%}
- **{{ antifeature.title }}**: {{ antifeature.description }} {% endfor %} {%
endif -%}
2022-02-23 08:18:05 +01:00
## Documentation and resources
2021-04-23 20:01:40 +02:00
{% if upstream.website -%}- Official app website: <{{ upstream.website }}> {%
endif -%} {% if upstream.userdoc -%}- Official user documentation: <{{
upstream.userdoc }}> {% endif -%} {% if upstream.admindoc -%}- Official admin
documentation: <{{ upstream.admindoc }}> {% endif -%} {% if upstream.code -%}-
Upstream app code repository: <{{ upstream.code }}> {% endif -%}
- YunoHost Store: <https://apps.yunohost.org/app/{{manifest.id}}>
- Report a bug: <https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues>
2021-04-23 20:01:40 +02:00
## Developer info
2021-04-23 20:01:40 +02:00
Please send your pull request to the [testing
branch](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing).
2021-04-23 20:01:40 +02:00
To try the testing branch, please proceed like that.
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
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
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
2024-03-07 00:59:01 +01:00