hosting/ynh-apps_tools
1
0
Fork 0
Code Activity

feat(readme_generator/i18n): make README.md.j2 translatable

Browse source
This commit is contained in:
Laurent Peuch 2024-03-20 04:27:08 +01:00 committed by Bram
parent 016f472ac9
commit 0b9ad1a9c2
1 changed files with 34 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
readme_generator/templates/README.md.j2
View file

@ -1,83 +1,84 @@
{% if manifest.id == "example" -%} {% if manifest.id == "example" -%}
# Packaging an app, starting from this 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. * {{ _("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 `manifest.json` with app specific info.") }}
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. * {{ _("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) * {{ _("Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)") }}
* 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
It shall NOT be edited by hand. It shall NOT be edited by hand.") }}
--> -->
# {{manifest.name}} for YunoHost # {{ _("%(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) [![{{ _("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 {{manifest.name}} with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}}) [![{{ _("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}})
*[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.name}} quickly and simply on a YunoHost server. > *{{ _("This package allows you to install %(application_name)s 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.")|format(application_name=manifest.name) }}*
## Overview ## {{ _("Overview") }}
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %} {% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %}
**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}} {{ _("**Shipped version:**") }} {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}
{% endif -%} {% endif -%}
{% if upstream.demo %} {% if upstream.demo %}
**Demo:** <{{upstream.demo}}> {{ _("**Demo:**") }} <{{upstream.demo}}>
{% endif -%} {% endif -%}
{% if screenshots %} {% if screenshots %}
## Screenshots ## {{ _("Screenshots") }}
{% for screenshot in screenshots -%} {% for screenshot in screenshots -%}
![Screenshot of {{manifest.name}}](./{{screenshot}}) ![{{ _("Screenshot of %(application_name)s")|format(application_name=manifest.name) }}](./{{screenshot}})
{% endfor %} {% endfor %}
{% endif -%} {% endif -%}
{% if disclaimer -%} {% if disclaimer -%}
## Disclaimers / important information ## {{ _("Disclaimers / important information") }}
{{ disclaimer }} {{ disclaimer }}
{% endif -%} {% endif -%}
{% if antifeatures -%} {% if antifeatures -%}
## :red_circle: Antifeatures ## :red_circle: {{ _("Antifeatures") }}
{% for antifeature in antifeatures.values() -%} {% for antifeature in antifeatures.values() -%}
- **{{ antifeature.title }}**: {{ antifeature.description }} - **{{ antifeature.title }}**: {{ antifeature.description }}
{% endfor %} {% endfor %}
{% endif -%} {% endif -%}
## Documentation and resources ## {{ _("Documentation and resources") }}
{% if upstream.website -%}- Official app website: <{{ upstream.website }}> {% if upstream.website -%}- {{ _("Official app website:") }} <{{ upstream.website }}>
{% endif -%} {% endif -%}
{% if upstream.userdoc -%}- Official user documentation: <{{ upstream.userdoc }}> {% if upstream.userdoc -%}- {{ _("Official user documentation:") }} <{{ upstream.userdoc }}>
{% endif -%} {% endif -%}
{% if upstream.admindoc -%}- Official admin documentation: <{{ upstream.admindoc }}> {% if upstream.admindoc -%}- {{ _("Official admin documentation:") }} <{{ upstream.admindoc }}>
{% endif -%} {% endif -%}
{% if upstream.code -%}- Upstream app code repository: <{{ upstream.code }}> {% if upstream.code -%}- {{ _("Upstream app code repository:") }} <{{ upstream.code }}>
{% endif -%} {% endif -%}
- YunoHost Store: <https://apps.yunohost.org/app/{{manifest.id}}> - {{ _("YunoHost Store:") }} <https://apps.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>
## Developer info ## {{ _("Developer info") }}
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing). {{ _("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.
{{ _("To try the testing branch, please proceed like that.") }}
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
@ -85,5 +86,5 @@ or
sudo yunohost app upgrade {{manifest.id}} -u https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug 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> **{{ _("More info regarding app packaging:") }}** <https://yunohost.org/packaging_apps>