ynh-apps_tools/readme_generator/templates/README.md.j2

{% 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/new?template_name=example_ynh&template_owner=YunoHost) button on the Github repo") }}
- {{ _("Edit the `manifest.toml` 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)") }}
- {{ _("Edit the `change_url` and `config` scripts too, or remove them if you have no use of them") }}
- {{ _("Add a `LICENSE` file for the package.") }}
  - {{ _("NB: this `LICENSE` file is not meant to necessarily be the same LICENSE as the upstream app - it is only the LICENSE you want this package's code to published with and you can choose it freely! (If you don't know which to choose, we recommend [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt))") }}
- {{ _("Edit files under the `doc/` directory ([see the page about documenting packages](https://yunohost.org/packaging_app_doc))") }}
- {{ _("The `README.md` files are to be automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>") }}

---
{% endif -%}

<!--
{{ _("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.") }}
-->

# {{ _("%(application_name)s for YunoHost")|format(application_name=manifest.name) }}

[![{{ _("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)

[![{{ _("Install %(application_name)s with YunoHost")|format(application_name=manifest.name) }}](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}})

*[{{ _("Read this README in other languages.") }}](./ALL_README.md)*

> *{{ _("This package allows you to install %(application_name)s quickly and simply on a YunoHost server.")|format(application_name=manifest.name) }}*  
> *{{ _("If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.") }}*

## {{ _("Overview") }}

{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %}

**{{ _("Shipped version:") }}** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}
{% endif -%}

{% if upstream.demo %}
**{{ _("Demo:") }}** <{{upstream.demo}}>
{% endif -%}

{% if screenshots %}
## {{ _("Screenshots") }}

{% for screenshot in screenshots -%}
    ![{{ _("Screenshot of %(application_name)s")|format(application_name=manifest.name) }}](./{{screenshot}})
{% endfor %}
{% endif -%}

{% if disclaimer -%}
## {{ _("Disclaimers / important information") }}

{{ disclaimer }}
{% endif -%}

{% if antifeatures -%}
## :red_circle: {{ _("Antifeatures") }}

{% for antifeature in antifeatures.values() -%}
  - **{{ antifeature.title }}**: {{ antifeature.description }}
{% endfor %}
{% endif -%}

## {{ _("Documentation and resources") }}

{% 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>

## {{ _("Developer info") }}

{{ _("Please send your pull request to the [`testing` branch](%(testing_branch_url)s).")|format(testing_branch_url="https://github.com/YunoHost-Apps/" + manifest.id + "_ynh/tree/testing") }}

{{ _("To try the `testing` branch, please proceed like that:") }}

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
{{ _("or") }}
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>