Changes to the Readme.md.j2 :
* Fix whitespace / empty lines in generated files * Add an 'upstream.version' variable (with fallback on 'manifest.version')
This commit is contained in:
Félix Piédallu
parent
baf9e0dd0c
commit
687453b38e
2 changed files with 38 additions and 30 deletions
|
|
@ -1,4 +1,4 @@
|
|||
{% if manifest.id == "example" %}
|
||||
{% if manifest.id == "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.
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
- 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 %}
|
||||
|
||||
{% endif -%}
|
||||
---
|
||||
|
||||
<!--
|
||||
|
|
@ -19,42 +19,46 @@ It shall NOT be edited by hand.
|
|||
|
||||
# {{manifest.name}} for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
|
||||
*[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.*
|
||||
|
||||
## Overview
|
||||
|
||||
{{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 screenshots %}
|
||||
{% if screenshots -%}
|
||||
## Screenshots
|
||||
|
||||
{% for screenshot in screenshots %}
|
||||
|
||||
{% for screenshot in screenshots -%}
|
||||
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% endif -%}
|
||||
|
||||
{% if disclaimer %}
|
||||
{% if disclaimer -%}
|
||||
## Disclaimers / important information
|
||||
|
||||
{{ disclaimer }}
|
||||
{% endif %}
|
||||
{% 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 %}
|
||||
{% 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 documentation for this app: https://yunohost.org/app_{{manifest.id}}
|
||||
* Report a bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues
|
||||
|
||||
|
|
|
|||
|
|
@ -1,42 +1,46 @@
|
|||
# {{manifest.name}} pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
|
||||
*[Read this readme in english.](./README.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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
{{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 screenshots %}
|
||||
{% if screenshots -%}
|
||||
## Captures d'écran
|
||||
|
||||
{% for screenshot in screenshots %}
|
||||
|
||||
{% for screenshot in screenshots -%}
|
||||
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% endif -%}
|
||||
|
||||
{% if disclaimer %}
|
||||
{% if disclaimer -%}
|
||||
## Avertissements / informations importantes
|
||||
|
||||
{{ disclaimer }}
|
||||
{% endif %}
|
||||
{% endif -%}
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
{% if upstream.website %}* Site official 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 %}
|
||||
{% if upstream.website -%}* Site official 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 -%}
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_{{manifest.id}}
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue