From 4098e90f5943a59997a9321468c03cece280e84f Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Mon, 25 Mar 2024 06:31:10 +0100 Subject: [PATCH] another bunch of readme improvements --- readme_generator/messages.pot | 91 ++++++++++++++----------- readme_generator/templates/README.md.j2 | 17 ++--- 2 files changed, 59 insertions(+), 49 deletions(-) diff --git a/readme_generator/messages.pot b/readme_generator/messages.pot index ffad455..ba7d1fb 100644 --- a/readme_generator/messages.pot +++ b/readme_generator/messages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PROJECT VERSION\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2024-03-25 01:09+0100\n" +"POT-Creation-Date: 2024-03-25 06:29+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -30,7 +30,7 @@ msgstr "" msgid "" "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." +" button on the Github repo" msgstr "" #: templates/README.md.j2:5 @@ -40,13 +40,13 @@ msgstr "" #: templates/README.md.j2:6 msgid "" "Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, " -"and any relevant conf files in `conf/`." +"and any relevant conf files in `conf/`" msgstr "" #: templates/README.md.j2:7 msgid "" "Using the [script helpers " -"documentation.](https://yunohost.org/packaging_apps_helpers)" +"documentation](https://yunohost.org/packaging_apps_helpers)" msgstr "" #: templates/README.md.j2:8 @@ -56,142 +56,151 @@ msgid "" msgstr "" #: templates/README.md.j2:9 -msgid "" -"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)." +msgid "Add a `LICENSE` file for the package." msgstr "" #: templates/README.md.j2:10 -msgid "Edit files under the `doc/` directory" +msgid "" +"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 freely choose it! (If you don't know which" +" to choose, we recommend [the " +"AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt))" msgstr "" #: templates/README.md.j2:11 +msgid "Edit files under the `doc/` directory" +msgstr "" + +#: templates/README.md.j2:12 msgid "" "The `README.md` files are to be automatically generated by " "" msgstr "" -#: templates/README.md.j2:17 +#: templates/README.md.j2:18 msgid "" "N.B.: This README was automatically generated by " "\n" "It shall NOT be edited by hand." msgstr "" -#: templates/README.md.j2:21 +#: templates/README.md.j2:22 #, python-format msgid "%(application_name)s for YunoHost" msgstr "" -#: templates/README.md.j2:23 +#: templates/README.md.j2:24 msgid "Integration level" msgstr "" -#: templates/README.md.j2:23 +#: templates/README.md.j2:24 msgid "Working status" msgstr "" -#: templates/README.md.j2:23 +#: templates/README.md.j2:24 msgid "Maintenance status" msgstr "" -#: templates/README.md.j2:25 +#: templates/README.md.j2:26 #, python-format msgid "Install %(application_name)s with YunoHost" msgstr "" -#: templates/README.md.j2:27 +#: templates/README.md.j2:28 msgid "Read this README is other languages." msgstr "" -#: templates/README.md.j2:29 +#: templates/README.md.j2:30 #, python-format msgid "" "This package allows you to install %(application_name)s quickly and " -"simply on a YunoHost server.\n" -"If you don't have YunoHost, please consult [the " -"guide](https://yunohost.org/#/install) to learn how to install it." +"simply on a YunoHost server." msgstr "" -#: templates/README.md.j2:32 +#: templates/README.md.j2:31 +msgid "" +"If you don't have YunoHost, please consult [the " +"guide](https://yunohost.org/install) to learn how to install it." +msgstr "" + +#: templates/README.md.j2:33 msgid "Overview" msgstr "" -#: templates/README.md.j2:35 +#: templates/README.md.j2:37 msgid "Shipped version:" msgstr "" -#: templates/README.md.j2:39 +#: templates/README.md.j2:41 msgid "Demo:" msgstr "" -#: templates/README.md.j2:43 +#: templates/README.md.j2:45 msgid "Screenshots" msgstr "" -#: templates/README.md.j2:46 +#: templates/README.md.j2:48 #, python-format msgid "Screenshot of %(application_name)s" msgstr "" -#: templates/README.md.j2:51 +#: templates/README.md.j2:53 msgid "Disclaimers / important information" msgstr "" -#: templates/README.md.j2:57 +#: templates/README.md.j2:59 msgid "Antifeatures" msgstr "" -#: templates/README.md.j2:64 +#: templates/README.md.j2:66 msgid "Documentation and resources" msgstr "" -#: templates/README.md.j2:66 +#: templates/README.md.j2:68 msgid "Official app website:" msgstr "" -#: templates/README.md.j2:68 +#: templates/README.md.j2:70 msgid "Official user documentation:" msgstr "" -#: templates/README.md.j2:70 +#: templates/README.md.j2:72 msgid "Official admin documentation:" msgstr "" -#: templates/README.md.j2:72 +#: templates/README.md.j2:74 msgid "Upstream app code repository:" msgstr "" -#: templates/README.md.j2:74 +#: templates/README.md.j2:76 msgid "YunoHost Store:" msgstr "" -#: templates/README.md.j2:75 +#: templates/README.md.j2:77 msgid "Report a bug:" msgstr "" -#: templates/README.md.j2:77 +#: templates/README.md.j2:79 msgid "Developer info" msgstr "" -#: templates/README.md.j2:79 +#: templates/README.md.j2:81 #, python-format msgid "" "Please send your pull request to the [testing " -"branch](%(testing_branch_url)s)" +"branch](%(testing_branch_url)s)." msgstr "" -#: templates/README.md.j2:82 +#: templates/README.md.j2:83 msgid "To try the testing branch, please proceed like that:" msgstr "" -#: templates/README.md.j2:86 +#: templates/README.md.j2:87 msgid "or" msgstr "" -#: templates/README.md.j2:90 +#: templates/README.md.j2:91 msgid "More info regarding app packaging:" msgstr "" diff --git a/readme_generator/templates/README.md.j2 b/readme_generator/templates/README.md.j2 index c532f30..8b2088a 100644 --- a/readme_generator/templates/README.md.j2 +++ b/readme_generator/templates/README.md.j2 @@ -1,12 +1,13 @@ {% 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.") }} +- {{ _("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 `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 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).") }} +- {{ _("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 freely choose it! (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") }} - {{ _("The `README.md` files are to be automatically generated by ") }} @@ -26,12 +27,13 @@ It shall NOT be edited by hand.") }} *[{{ _("Read this README is other languages.") }}](./ALL_README.md)* -> *{{ _("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.")|format(application_name=manifest.name) }}* +> *{{ _("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 -%} @@ -76,8 +78,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## {{ _("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") }}, - +{{ _("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:") }}