Skip to content

Commit cd5c498

Browse files
committed
update & fix readme templates
1 parent 8245938 commit cd5c498

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

tools/readme_generator/templates/ALL_README.md.j2

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
[Read the README in English](README.md)
44

55
{% for filename, translated_sentence in links_to_other_READMEs %}
6-
* [{{ translated_sentence }}]({{ filename }})
6+
- [{{ translated_sentence }}]({{ filename }})
77
{% endfor %}
88

99
{% if False %}
1010
Yes this is a hack to add the translatable string to messages.pot
1111

1212
{{ _("Read the README in %(language)s") }}
1313
{% endif %}
14+

tools/readme_generator/templates/README.md.j2

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
{% if manifest.id == "example" -%}
22
# {{ _('Packaging an app, starting from this example') }}
33

4-
* {{ _("Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.") }}
5-
* {{ _("Edit the `manifest.json` with app specific info.") }}
6-
* {{ _("Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.") }}
7-
* {{ _("Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)") }}
8-
* {{ _("Add a `LICENSE` file for the package.") }}
9-
* {{ _("Edit `doc/DISCLAIMER*.md`") }}
10-
* {{ _("The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator") }}
4+
- {{ _("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.S") }}
5+
- {{ _("Edit the `manifest.toml` with app specific info") }}
6+
- {{ _("Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`.") }}
7+
- {{ _("Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)") }}
8+
- {{ _("Edit the `change_url` and `config` scripts too, or remove them if you have no use of them") }}
9+
- {{ _("Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).") }}
10+
- {{ _("Edit files under the `doc/` directory") }}
11+
- {{ _("The `README.md` files are to be automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>") }}
12+
13+
1114

1215
---
1316
{% endif -%}

0 commit comments

Comments
 (0)