hosting/ynh-apps_tools
1
0
Fork 0
Code Activity

Merge pull request #1155 from Salamandar/app_readme_templates

Browse source 
Changes to the Readme.md.j2 :
This commit is contained in:
Alexandre Aubin 2021-05-26 18:10:56 +02:00 committed by GitHub
commit 798dd4722f
2 changed files with 40 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README-generator/templates/README.md.j2
View file

@ -1,4 +1,4 @@
{% if manifest.id == "example" %} {% if manifest.id == "example" -%}
# Packaging your an app, starting from this example # 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. - Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
@ -8,9 +8,9 @@
- Add a `LICENSE` file for the package. - Add a `LICENSE` file for the package.
- Edit `doc/DISCLAIMER*.md` - Edit `doc/DISCLAIMER*.md`
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator - The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
{% endif %}
--- ---
{% endif -%}
<!-- <!--
N.B.: This README was 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
@ -20,41 +20,45 @@ It shall NOT be edited by hand.
# {{manifest.name}} for YunoHost # {{manifest.name}} for YunoHost
[![Integration level](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg)
[![Install {{manifest.id}} with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}}) [![Install {{manifest.name}} with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}})
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install {{manifest.id}} quickly and simply on a YunoHost server. > *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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
{{manifest.description[lang]}} {{manifest.description[lang]}}
**Shipped version:** {{manifest.version}} **Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}
{% if upstream.demo %}**Demo:** {{upstream.demo}}{% endif %} {% if upstream.demo %}**Demo:** {{upstream.demo}}{% endif %}
{% if screenshots %} {% if screenshots -%}
## Screenshots ## Screenshots
{% for screenshot in screenshots %} {% for screenshot in screenshots -%}
![](./doc/screenshots/{{screenshot}}) ![](./doc/screenshots/{{screenshot}})
{% endfor %} {% endfor %}
{% endif %} {% endif -%}
{% if disclaimer %} {% if disclaimer -%}
## Disclaimers / important information ## Disclaimers / important information
{{ disclaimer }} {{ disclaimer }}
{% endif %} {% endif -%}
## Documentation and resources ## Documentation and resources
{% if upstream.website %}* Official app website: {{ upstream.website }}{% endif %} {% if upstream.website -%}* Official app website: {{ upstream.website }}
{% if upstream.userdoc %}* Official user documentation: {{ upstream.userdoc }}{% endif %} {% endif -%}
{% if upstream.admindoc %}* Official admin documentation: {{ upstream.admindoc }}{% endif %} {% if upstream.userdoc -%}* Official user documentation: {{ upstream.userdoc }}
{% if upstream.code %}* Upstream app code repository: {{ upstream.code }}{% endif %} {% endif -%}
{% if upstream.admindoc -%}* Official admin documentation: {{ upstream.admindoc }}
{% endif -%}
{% if upstream.code -%}* Upstream app code repository: {{ upstream.code }}
{% endif -%}
* YunoHost documentation for this app: https://yunohost.org/app_{{manifest.id}} * YunoHost documentation for this app: https://yunohost.org/app_{{manifest.id}}
* Report a bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues

32
README-generator/templates/README_fr.md.j2
View file

@ -1,43 +1,47 @@
# {{manifest.name}} pour YunoHost # {{manifest.name}} pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg)
[![Installer {{manifest.id}} avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}}) [![Installer {{manifest.name}} avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}})
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install {{manifest.id}} quickly and simply on a YunoHost server. > *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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Vue d'ensemble ## Vue d'ensemble
{{manifest.description[lang]}} {{manifest.description[lang]}}
**Version incluse:** {{manifest.version}} **Version incluse:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}
{% if upstream.demo %}**Démo:** {{upstream.demo}}{% endif %} {% if upstream.demo %}**Démo :** {{upstream.demo}}{% endif %}
{% if screenshots %} {% if screenshots -%}
## Captures d'écran ## Captures d'écran
{% for screenshot in screenshots %} {% for screenshot in screenshots -%}
![](./doc/screenshots/{{screenshot}}) ![](./doc/screenshots/{{screenshot}})
{% endfor %} {% endfor %}
{% endif %} {% endif -%}
{% if disclaimer %} {% if disclaimer -%}
## Avertissements / informations importantes ## Avertissements / informations importantes
{{ disclaimer }} {{ disclaimer }}
{% endif %} {% endif -%}
## Documentations et ressources ## Documentations et ressources
{% if upstream.website %}* Site official de l'app : {{ upstream.website }}{% endif %} {% if upstream.website -%}* Site officiel de l'app : {{ upstream.website }}
{% if upstream.userdoc %}* Documentation officielle utilisateur: {{ upstream.userdoc }}{% endif %} {% endif -%}
{% if upstream.admindoc %}* Documentation officielle de l'admin: {{ upstream.admindoc }}{% endif %} {% if upstream.userdoc -%}* Documentation officielle utilisateur : {{ upstream.userdoc }}
{% if upstream.code %}* Dépôt de code officiel de l'app: {{ upstream.code }}{% endif %} {% endif -%}
* Documentation YunoHost pour cette app: https://yunohost.org/app_{{manifest.id}} {% 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 -%}
* Documentation YunoHost pour cette app : https://yunohost.org/app_{{manifest.id}}
* Signaler un bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues * Signaler un bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs