chores: update & fix readme templates (#2164)
This commit is contained in:
parent
78b3e394cc
commit
19e9708946
33 changed files with 187 additions and 203 deletions
|
@ -55,10 +55,12 @@ source venv/bin/activate
|
||||||
# Extract the english sentences from the code, needed if you modified it
|
# Extract the english sentences from the code, needed if you modified it
|
||||||
pybabel extract --ignore-dirs venv -F babel.cfg -o messages.pot .
|
pybabel extract --ignore-dirs venv -F babel.cfg -o messages.pot .
|
||||||
|
|
||||||
# If working on a new locale: initialize it (in this example: fr)
|
# If working on a new locale: initialize it: (in this example: fr)
|
||||||
pybabel init -i messages.pot -d translations -l fr
|
pybabel init -i messages.pot -d translations -l fr
|
||||||
# Otherwise, update the existing .po:
|
# Otherwise, update the existing .po:
|
||||||
pybabel update -i messages.pot -d translations
|
pybabel update -i messages.pot -d translations
|
||||||
|
# To update only a specific language: (in this example: fr)
|
||||||
|
pybabel update -i messages.pot -d translations -l fr
|
||||||
|
|
||||||
# ... translate stuff in translations/<lang>/LC_MESSAGES/messages.po
|
# ... translate stuff in translations/<lang>/LC_MESSAGES/messages.po
|
||||||
# re-run the 'update' command to let Babel properly format the text
|
# re-run the 'update' command to let Babel properly format the text
|
||||||
|
|
|
@ -69,10 +69,13 @@ def generate_READMEs(app_path: Path):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if sentence not in translations._catalog:
|
if sentence not in translations._catalog:
|
||||||
|
print(translations._catalog)
|
||||||
|
print(f"The sentence: {repr(sentence)} is not in the target catalog")
|
||||||
is_fully_translated = False
|
is_fully_translated = False
|
||||||
break
|
break
|
||||||
|
|
||||||
if not translations._catalog[sentence]:
|
if not translations._catalog[sentence]:
|
||||||
|
print(f"The sentence: '{repr(sentence)}' is not translated")
|
||||||
is_fully_translated = False
|
is_fully_translated = False
|
||||||
break
|
break
|
||||||
|
|
||||||
|
@ -86,6 +89,7 @@ def generate_READMEs(app_path: Path):
|
||||||
)
|
)
|
||||||
|
|
||||||
fully_translated_langs.sort()
|
fully_translated_langs.sort()
|
||||||
|
print(f"Available languages for translation: {', '.join(fully_translated_langs) if fully_translated_langs else []}")
|
||||||
|
|
||||||
screenshots: List[str] = []
|
screenshots: List[str] = []
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: PROJECT VERSION\n"
|
"Project-Id-Version: PROJECT VERSION\n"
|
||||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||||
"POT-Creation-Date: 2024-03-22 06:28+0100\n"
|
"POT-Creation-Date: 2024-03-23 03:25+0100\n"
|
||||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
|
@ -29,17 +29,17 @@ msgstr ""
|
||||||
#: templates/README.md.j2:4
|
#: templates/README.md.j2:4
|
||||||
msgid ""
|
msgid ""
|
||||||
"Copy this app before working on it, using the ['Use this "
|
"Copy this app before working on it, using the ['Use this "
|
||||||
"template'](https://github.com/YunoHost/example_ynh/generate) button on "
|
"template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost)"
|
||||||
"the Github repo."
|
" button on the Github repo."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:5
|
#: templates/README.md.j2:5
|
||||||
msgid "Edit the `manifest.json` with app specific info."
|
msgid "Edit the `manifest.toml` with app specific info"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:6
|
#: templates/README.md.j2:6
|
||||||
msgid ""
|
msgid ""
|
||||||
"Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts,"
|
"Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, "
|
||||||
"and any relevant conf files in `conf/`."
|
"and any relevant conf files in `conf/`."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -50,53 +50,63 @@ msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:8
|
#: templates/README.md.j2:8
|
||||||
msgid "Add a `LICENSE` file for the package."
|
msgid ""
|
||||||
|
"Edit the `change_url` and `config` scripts too, or remove them if you "
|
||||||
|
"have no use of them"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:9
|
#: templates/README.md.j2:9
|
||||||
msgid "Edit `doc/DISCLAIMER*.md`"
|
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)."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:10
|
#: templates/README.md.j2:10
|
||||||
msgid ""
|
msgid "Edit files under the `doc/` directory"
|
||||||
"The `README.md` files are to be automatically generated by "
|
|
||||||
"https://github.com/YunoHost/apps/tree/master/tools/readme_generator"
|
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:16
|
#: templates/README.md.j2:11
|
||||||
|
msgid ""
|
||||||
|
"The `README.md` files are to be automatically generated by "
|
||||||
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: templates/README.md.j2:17
|
||||||
msgid ""
|
msgid ""
|
||||||
"N.B.: This README was automatically generated by "
|
"N.B.: This README was automatically generated by "
|
||||||
"https://github.com/YunoHost/apps/tree/master/tools/readme_generator\n"
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>\n"
|
||||||
"It shall NOT be edited by hand."
|
"It shall NOT be edited by hand."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:20
|
#: templates/README.md.j2:21
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "%(application_name)s for YunoHost"
|
msgid "%(application_name)s for YunoHost"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Integration level"
|
msgid "Integration level"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Working status"
|
msgid "Working status"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Maintenance status"
|
msgid "Maintenance status"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:24
|
#: templates/README.md.j2:25
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Install %(application_name)s with YunoHost"
|
msgid "Install %(application_name)s with YunoHost"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:26
|
#: templates/README.md.j2:27
|
||||||
msgid "Read this README is other languages."
|
msgid "Read this README is other languages."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:28
|
#: templates/README.md.j2:29
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid ""
|
msgid ""
|
||||||
"This package allows you to install %(application_name)s quickly and "
|
"This package allows you to install %(application_name)s quickly and "
|
||||||
|
@ -105,79 +115,83 @@ msgid ""
|
||||||
"guide](https://yunohost.org/#/install) to learn how to install it."
|
"guide](https://yunohost.org/#/install) to learn how to install it."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:31
|
#: templates/README.md.j2:32
|
||||||
msgid "Overview"
|
msgid "Overview"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:34
|
#: templates/README.md.j2:35
|
||||||
msgid "**Shipped version:**"
|
msgid "**Shipped version:**"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:38
|
#: templates/README.md.j2:39
|
||||||
msgid "**Demo:**"
|
msgid "**Demo:**"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:42
|
#: templates/README.md.j2:43
|
||||||
msgid "Screenshots"
|
msgid "Screenshots"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:45
|
#: templates/README.md.j2:46
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Screenshot of %(application_name)s"
|
msgid "Screenshot of %(application_name)s"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:50
|
#: templates/README.md.j2:51
|
||||||
msgid "Disclaimers / important information"
|
msgid "Disclaimers / important information"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:56
|
#: templates/README.md.j2:57
|
||||||
msgid "Antifeatures"
|
msgid "Antifeatures"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:63
|
#: templates/README.md.j2:64
|
||||||
msgid "Documentation and resources"
|
msgid "Documentation and resources"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:65
|
#: templates/README.md.j2:66
|
||||||
msgid "Official app website:"
|
msgid "Official app website:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:67
|
#: templates/README.md.j2:68
|
||||||
msgid "Official user documentation:"
|
msgid "Official user documentation:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:69
|
#: templates/README.md.j2:70
|
||||||
msgid "Official admin documentation:"
|
msgid "Official admin documentation:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:71
|
#: templates/README.md.j2:72
|
||||||
msgid "Upstream app code repository:"
|
msgid "Upstream app code repository:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:73
|
#: templates/README.md.j2:74
|
||||||
msgid "YunoHost Store:"
|
msgid "YunoHost Store:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:74
|
#: templates/README.md.j2:75
|
||||||
msgid "Report a bug:"
|
msgid "Report a bug:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:76
|
#: templates/README.md.j2:77
|
||||||
msgid "Developer info"
|
msgid "Developer info"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:78
|
#: templates/README.md.j2:79
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid ""
|
msgid ""
|
||||||
"Please send your pull request to the [testing "
|
"Please send your pull request to the [testing "
|
||||||
"branch](%(testing_branch_url)s)"
|
"branch](%(testing_branch_url)s)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:81
|
#: templates/README.md.j2:82
|
||||||
msgid "To try the testing branch, please proceed like that."
|
msgid "To try the testing branch, please proceed like that."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:89
|
#: templates/README.md.j2:86
|
||||||
|
msgid "or"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: templates/README.md.j2:90
|
||||||
msgid "More info regarding app packaging:"
|
msgid "More info regarding app packaging:"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
[Read the README in English](README.md)
|
[Read the README in English](README.md)
|
||||||
|
|
||||||
{% for filename, translated_sentence in links_to_other_READMEs %}
|
{% for filename, translated_sentence in links_to_other_READMEs %}
|
||||||
* [{{ translated_sentence }}]({{ filename }})
|
- [{{ translated_sentence }}]({{ filename }})
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
{% if False %}
|
{% if False %}
|
||||||
|
@ -11,3 +11,4 @@ Yes this is a hack to add the translatable string to messages.pot
|
||||||
|
|
||||||
{{ _("Read the README in %(language)s") }}
|
{{ _("Read the README in %(language)s") }}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
|
@ -1,19 +1,20 @@
|
||||||
{% 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/new?template_name=example_ynh&template_owner=YunoHost) button on the Github repo.") }}
|
||||||
* {{ _("Edit the `manifest.json` with app specific info.") }}
|
- {{ _("Edit the `manifest.toml` 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.") }}
|
- {{ _("Edit the `change_url` and `config` scripts too, or remove them if you have no use of them") }}
|
||||||
* {{ _("Edit `doc/DISCLAIMER*.md`") }}
|
- {{ _("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).") }}
|
||||||
* {{ _("The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator") }}
|
- {{ _("Edit files under the `doc/` directory") }}
|
||||||
|
- {{ _("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.") }}
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
@ -82,7 +83,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
```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
|
||||||
or
|
{{ _("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
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
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.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
|
@ -1,61 +0,0 @@
|
||||||
<!--
|
|
||||||
Nota bene : ce README est automatiquement généré par https://github.com/YunoHost/apps/tree/master/tools/readme_generator
|
|
||||||
Il ne doit pas être modifié à la main.
|
|
||||||
-->
|
|
||||||
|
|
||||||
# GoToSocial pour YunoHost
|
|
||||||
|
|
||||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/gotosocial.svg)](https://dash.yunohost.org/appci/app/gotosocial) ![Status du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gotosocial.status.svg) ![Statut demaintenance](https://ci-apps.yunohost.org/ci/badges/gotosocial.maintain.svg)
|
|
||||||
|
|
||||||
[![Installer GoToSocial avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial)
|
|
||||||
|
|
||||||
*[Lire le README dans d'autres langues.](./ALL_README.md)*
|
|
||||||
|
|
||||||
> *Ce package vous permet d’installer GoToSocial rapidement et simplement sur un serveur YunoHost.
|
|
||||||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
|
||||||
|
|
||||||
## Vue d'ensemble
|
|
||||||
|
|
||||||
Un serveur de réseau social véloce basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang.
|
|
||||||
|
|
||||||
Avec GoToSocial, vous pouvez rester en contact avec vos amis, publier, lire et partager des images et des articles. Tout cela sans être pisté ni subir de publicité !
|
|
||||||
|
|
||||||
Vous pouvez consulter la documentation officielle à l'adresse : [docs.gotosocial.org](https://docs.gotosocial.org).
|
|
||||||
La documentation de ce paquet YunoHost [est lisible ici](./doc/DOCS_fr.md) et l'admin est **vivement encouragé-e à la lire** !
|
|
||||||
|
|
||||||
Veuillez noter que ce paquet utilise la ["i'm so tired" software license 1.0](https://github.com/YunoHost-Apps/gotosocial_ynh/blob/master/LICENSE), veuillez la lire et l'accepter avant de procéder à l'installation.
|
|
||||||
|
|
||||||
**Version incluse :** 0.13.3~ynh1
|
|
||||||
|
|
||||||
## Captures d'écran
|
|
||||||
|
|
||||||
![Capture d'écran de GoToSocial](./doc/screenshots/screenshot.png)
|
|
||||||
|
|
||||||
## :red_circle: Anti-fonctionnalités
|
|
||||||
|
|
||||||
- **Logiciel en version alpha**: Le logiciel est au tout début de son développement. Il pourrait contenir des fonctionnalités changeantes ou instables, des bugs, et des failles de sécurité.
|
|
||||||
- **Package sous licence libre restreinte**: Le package YunoHost de cette application est sous une licence globalement libre, mais avec des clauses qui pourraient restreindre son utilisation.
|
|
||||||
|
|
||||||
## Documentations et ressources
|
|
||||||
|
|
||||||
- Site officiel de l’app : <https://gotosocial.org/>
|
|
||||||
- Documentation officielle utilisateur : <https://docs.gotosocial.org/en/latest/>
|
|
||||||
- Documentation officielle de l'admin : <https://docs.gotosocial.org/en/latest/>
|
|
||||||
- Dépôt de code officiel de l’app : <https://github.com/superseriousbusiness/gotosocial>
|
|
||||||
- YunoHost Store : <https://apps.yunohost.org/app/gotosocial>
|
|
||||||
- Signaler un bug : <https://github.com/YunoHost-Apps/gotosocial_ynh/issues>
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche branch](https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing),
|
|
||||||
|
|
||||||
|
|
||||||
Pour essayer la branche testing, procédez comme suit.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
|
||||||
or
|
|
||||||
sudo yunohost app upgrade gotosocial -u https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
|
|
@ -1,46 +1,31 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
import difflib
|
|
||||||
import tempfile
|
import tempfile
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
CWD = Path(__file__).resolve().parent
|
TEST_DIRECTORY = Path(__file__).resolve().parent
|
||||||
|
|
||||||
TEST_APP_NAME = "gotosocial_ynh"
|
TEST_APP_NAME = "gotosocial_ynh"
|
||||||
TEST_APP_REPO = "https://github.com/yunohost-apps/gotosocial_ynh"
|
TEST_APP_REPO = "https://github.com/yunohost-apps/gotosocial_ynh"
|
||||||
TEST_APP_COMMIT_ID = "8f788213b363a46a5b6faa8f844d86d4adac9446"
|
TEST_APP_COMMIT_ID = "8f788213b363a46a5b6faa8f844d86d4adac9446"
|
||||||
|
|
||||||
|
|
||||||
def diff_files(file_a: Path, file_b: Path) -> bool:
|
|
||||||
lines_a = file_a.open(encoding="utf-8").readlines()
|
|
||||||
lines_b = file_b.open(encoding="utf-8").readlines()
|
|
||||||
|
|
||||||
diffs = list(
|
|
||||||
difflib.unified_diff(
|
|
||||||
lines_a, lines_b, fromfile="README.before.md", tofile="README.after.md"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
print("".join(diffs))
|
|
||||||
return len(diffs) == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_running_make_readme():
|
def test_running_make_readme():
|
||||||
with tempfile.TemporaryDirectory() as tempdir:
|
with tempfile.TemporaryDirectory() as tempdir:
|
||||||
tempdir = Path(tempdir)
|
tempdir = Path(tempdir)
|
||||||
DIRECTORY = tempdir / TEST_APP_NAME
|
temporary_tested_app_directory = tempdir / TEST_APP_NAME
|
||||||
|
|
||||||
subprocess.check_call(["git", "clone", "-q", TEST_APP_REPO, DIRECTORY])
|
subprocess.check_call(["git", "clone", "-q", TEST_APP_REPO, temporary_tested_app_directory])
|
||||||
subprocess.check_call(
|
subprocess.check_call(
|
||||||
["git", "checkout", "-q", TEST_APP_COMMIT_ID], cwd=DIRECTORY
|
["git", "checkout", "-q", TEST_APP_COMMIT_ID], cwd=temporary_tested_app_directory
|
||||||
)
|
)
|
||||||
|
|
||||||
# Now run test...
|
# Now run test...
|
||||||
subprocess.check_call([CWD.parent / "make_readme.py", DIRECTORY])
|
subprocess.check_call([TEST_DIRECTORY.parent / "make_readme.py", temporary_tested_app_directory])
|
||||||
|
|
||||||
assert diff_files(CWD / "README.md", DIRECTORY / "README.md")
|
assert open(TEST_DIRECTORY / "README.md").read() == open(temporary_tested_app_directory / "README.md").read()
|
||||||
assert diff_files(CWD / "README_fr.md", DIRECTORY / "README_fr.md")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -13,11 +13,12 @@ msgstr ""
|
||||||
"Language-Team: French <https://translate.yunohost.org/projects/yunohost/"
|
"Language-Team: French <https://translate.yunohost.org/projects/yunohost/"
|
||||||
"readme-generator/fr/>\n"
|
"readme-generator/fr/>\n"
|
||||||
"Language: fr\n"
|
"Language: fr\n"
|
||||||
"MIME-Version: 1.0\n"
|
"Language-Team: French <https://translate.yunohost.org/projects/yunohost"
|
||||||
"Content-Type: text/plain; charset=UTF-8\n"
|
"/readme-generator/fr/>\n"
|
||||||
"Content-Transfer-Encoding: 8bit\n"
|
|
||||||
"Plural-Forms: nplurals=2; plural=n > 1;\n"
|
"Plural-Forms: nplurals=2; plural=n > 1;\n"
|
||||||
"X-Generator: Weblate 5.3.1\n"
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
"Generated-By: Babel 2.14.0\n"
|
"Generated-By: Babel 2.14.0\n"
|
||||||
|
|
||||||
#: templates/ALL_README.md.j2:12
|
#: templates/ALL_README.md.j2:12
|
||||||
|
@ -30,23 +31,28 @@ msgid "Packaging an app, starting from this example"
|
||||||
msgstr "Packager une application, à partir de cet exemple"
|
msgstr "Packager une application, à partir de cet exemple"
|
||||||
|
|
||||||
#: templates/README.md.j2:4
|
#: templates/README.md.j2:4
|
||||||
|
#, fuzzy
|
||||||
msgid ""
|
msgid ""
|
||||||
"Copy this app before working on it, using the ['Use this template'](https://"
|
"Copy this app before working on it, using the ['Use this "
|
||||||
"github.com/YunoHost/example_ynh/generate) button on the Github repo."
|
"template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost)"
|
||||||
|
" button on the Github repo."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Copiez cette application avant de travailler dessus, en utilisant le bouton "
|
"Copiez cette application avant de travailler dessus, en utilisant le "
|
||||||
"['Utilisez ce template'](https://github.com/YunoHost/example_ynh/generate) "
|
"bouton ['Utilisez ce "
|
||||||
|
"template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost)"
|
||||||
" sur ce dépôt Github."
|
" sur ce dépôt Github."
|
||||||
|
|
||||||
#: templates/README.md.j2:5
|
#: templates/README.md.j2:5
|
||||||
msgid "Edit the `manifest.json` with app specific info."
|
#, fuzzy
|
||||||
|
msgid "Edit the `manifest.toml` with app specific info"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Éditez le `manifest.json` avec les informations spécifiques à cette "
|
"Éditez le `manifest.toml` avec les informations spécifiques à cette "
|
||||||
"application."
|
"application."
|
||||||
|
|
||||||
#: templates/README.md.j2:6
|
#: templates/README.md.j2:6
|
||||||
|
#, fuzzy
|
||||||
msgid ""
|
msgid ""
|
||||||
"Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, "
|
"Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, "
|
||||||
"and any relevant conf files in `conf/`."
|
"and any relevant conf files in `conf/`."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Éditez les scripts `install`, `upgrade`, `remove`, `backup` et `restore` "
|
"Éditez les scripts `install`, `upgrade`, `remove`, `backup` et `restore` "
|
||||||
|
@ -54,150 +60,182 @@ msgstr ""
|
||||||
|
|
||||||
#: templates/README.md.j2:7
|
#: templates/README.md.j2:7
|
||||||
msgid ""
|
msgid ""
|
||||||
"Using the [script helpers documentation.](https://yunohost.org/"
|
"Using the [script helpers "
|
||||||
"packaging_apps_helpers)"
|
"documentation.](https://yunohost.org/packaging_apps_helpers)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Utilisez la [documentation des helpers.](https://yunohost.org/"
|
"Utilisez la [documentation des "
|
||||||
"packaging_apps_helpers)"
|
"helpers.](https://yunohost.org/packaging_apps_helpers)"
|
||||||
|
|
||||||
#: templates/README.md.j2:8
|
#: templates/README.md.j2:8
|
||||||
msgid "Add a `LICENSE` file for the package."
|
msgid ""
|
||||||
msgstr "Ajoutez un fichier `LICENCE` for le paquet."
|
"Edit the `change_url` and `config` scripts too, or remove them if you "
|
||||||
|
"have no use of them"
|
||||||
|
msgstr ""
|
||||||
|
"Modifiez également les scripts `change_url` et `config`, ou supprimez-les"
|
||||||
|
" si vous n'en avez pas l'utilité"
|
||||||
|
|
||||||
#: templates/README.md.j2:9
|
#: templates/README.md.j2:9
|
||||||
msgid "Edit `doc/DISCLAIMER*.md`"
|
msgid ""
|
||||||
msgstr "Éditez `doc/DISCLAIMER*.md`"
|
"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)."
|
||||||
|
msgstr ""
|
||||||
|
"Ajouter un fichier `LICENSE` pour le paquet. NB : ce fichier LICENSE "
|
||||||
|
"n'est pas censé être nécessairement identique à la LICENCE de "
|
||||||
|
"l'application packagée - c'est seulement la LICENCE avec laquelle vous "
|
||||||
|
"voulez que le code de ce paquet soit publié ;). Nous recommandons "
|
||||||
|
"d'utiliser [l'AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt)."
|
||||||
|
|
||||||
#: templates/README.md.j2:10
|
#: templates/README.md.j2:10
|
||||||
msgid ""
|
msgid "Edit files under the `doc/` directory"
|
||||||
"The `README.md` files are to be automatically generated by https://github."
|
msgstr "Modifier des fichiers dans le dossier `doc/`"
|
||||||
"com/YunoHost/apps/tree/master/tools/readme_generator"
|
|
||||||
msgstr ""
|
|
||||||
"Les fichiers `README.md` sont automatiquement généré par https://github.com/"
|
|
||||||
"YunoHost/apps/tree/master/tools/readme_generator"
|
|
||||||
|
|
||||||
#: templates/README.md.j2:16
|
#: templates/README.md.j2:11
|
||||||
|
#, fuzzy
|
||||||
msgid ""
|
msgid ""
|
||||||
"N.B.: This README was automatically generated by https://github.com/YunoHost/"
|
"The `README.md` files are to be automatically generated by "
|
||||||
"apps/tree/master/tools/readme_generator\n"
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>"
|
||||||
|
msgstr ""
|
||||||
|
"Les fichiers `README.md` sont automatiquement généré par "
|
||||||
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>"
|
||||||
|
|
||||||
|
#: templates/README.md.j2:17
|
||||||
|
#, fuzzy
|
||||||
|
msgid ""
|
||||||
|
"N.B.: This README was automatically generated by "
|
||||||
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>\n"
|
||||||
"It shall NOT be edited by hand."
|
"It shall NOT be edited by hand."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Nota bene : ce README est automatiquement généré par https://github.com/"
|
"Nota bene : ce README est automatiquement généré par "
|
||||||
"YunoHost/apps/tree/master/tools/readme_generator\n"
|
"<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>\n"
|
||||||
"Il ne doit pas être modifié à la main."
|
"Il ne doit pas être modifié à la main."
|
||||||
|
|
||||||
#: templates/README.md.j2:20
|
#: templates/README.md.j2:21
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "%(application_name)s for YunoHost"
|
msgid "%(application_name)s for YunoHost"
|
||||||
msgstr "%(application_name)s pour YunoHost"
|
msgstr "%(application_name)s pour YunoHost"
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Integration level"
|
msgid "Integration level"
|
||||||
msgstr "Niveau d'intégration"
|
msgstr "Niveau d'intégration"
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Working status"
|
msgid "Working status"
|
||||||
msgstr "Status du fonctionnement"
|
msgstr "Status du fonctionnement"
|
||||||
|
|
||||||
#: templates/README.md.j2:22
|
#: templates/README.md.j2:23
|
||||||
msgid "Maintenance status"
|
msgid "Maintenance status"
|
||||||
msgstr "Statut demaintenance"
|
msgstr "Statut demaintenance"
|
||||||
|
|
||||||
#: templates/README.md.j2:24
|
#: templates/README.md.j2:25
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Install %(application_name)s with YunoHost"
|
msgid "Install %(application_name)s with YunoHost"
|
||||||
msgstr "Installer %(application_name)s avec YunoHost"
|
msgstr "Installer %(application_name)s avec YunoHost"
|
||||||
|
|
||||||
#: templates/README.md.j2:26
|
#: templates/README.md.j2:27
|
||||||
msgid "Read this README is other languages."
|
msgid "Read this README is other languages."
|
||||||
msgstr "Lire le README dans d'autres langues."
|
msgstr "Lire le README dans d'autres langues."
|
||||||
|
|
||||||
#: templates/README.md.j2:28
|
#: templates/README.md.j2:29
|
||||||
#, python-format
|
#, fuzzy, python-format
|
||||||
msgid ""
|
msgid ""
|
||||||
"This package allows you to install %(application_name)s quickly and simply "
|
"This package allows you to install %(application_name)s quickly and "
|
||||||
"on a YunoHost server.\n"
|
"simply on a YunoHost server.\n"
|
||||||
"If you don't have YunoHost, please consult [the guide](https://yunohost.org/"
|
"If you don't have YunoHost, please consult [the "
|
||||||
"#/install) to learn how to install it."
|
"guide](https://yunohost.org/#/install) to learn how to install it."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Ce package vous permet d’installer %(application_name)s rapidement et "
|
"Ce package vous permet d’installer %(application_name)s rapidement et "
|
||||||
"simplement sur un serveur YunoHost.\n"
|
"simplement sur un serveur YunoHost.\n"
|
||||||
"Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) "
|
"Si vous n’avez pas YunoHost, regardez "
|
||||||
"pour savoir comment l’installer et en profiter."
|
"[ici](https://yunohost.org/#/install) pour savoir comment l’installer et "
|
||||||
|
"en profiter."
|
||||||
|
|
||||||
#: templates/README.md.j2:31
|
#: templates/README.md.j2:32
|
||||||
msgid "Overview"
|
msgid "Overview"
|
||||||
msgstr "Vue d'ensemble"
|
msgstr "Vue d'ensemble"
|
||||||
|
|
||||||
#: templates/README.md.j2:34
|
#: templates/README.md.j2:35
|
||||||
msgid "**Shipped version:**"
|
msgid "**Shipped version:**"
|
||||||
msgstr "**Version incluse :**"
|
msgstr "**Version incluse :**"
|
||||||
|
|
||||||
#: templates/README.md.j2:38
|
#: templates/README.md.j2:39
|
||||||
msgid "**Demo:**"
|
msgid "**Demo:**"
|
||||||
msgstr "**Démo:**"
|
msgstr "**Démo:**"
|
||||||
|
|
||||||
#: templates/README.md.j2:42
|
#: templates/README.md.j2:43
|
||||||
msgid "Screenshots"
|
msgid "Screenshots"
|
||||||
msgstr "Captures d'écran"
|
msgstr "Captures d'écran"
|
||||||
|
|
||||||
#: templates/README.md.j2:45
|
#: templates/README.md.j2:46
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Screenshot of %(application_name)s"
|
msgid "Screenshot of %(application_name)s"
|
||||||
msgstr "Capture d'écran de %(application_name)s"
|
msgstr "Capture d'écran de %(application_name)s"
|
||||||
|
|
||||||
#: templates/README.md.j2:50
|
#: templates/README.md.j2:51
|
||||||
msgid "Disclaimers / important information"
|
msgid "Disclaimers / important information"
|
||||||
msgstr "Avertissements / informations importantes"
|
msgstr "Avertissements / informations importantes"
|
||||||
|
|
||||||
#: templates/README.md.j2:56
|
#: templates/README.md.j2:57
|
||||||
msgid "Antifeatures"
|
msgid "Antifeatures"
|
||||||
msgstr "Anti-fonctionnalités"
|
msgstr "Anti-fonctionnalités"
|
||||||
|
|
||||||
#: templates/README.md.j2:63
|
#: templates/README.md.j2:64
|
||||||
msgid "Documentation and resources"
|
msgid "Documentation and resources"
|
||||||
msgstr "Documentations et ressources"
|
msgstr "Documentations et ressources"
|
||||||
|
|
||||||
#: templates/README.md.j2:65
|
#: templates/README.md.j2:66
|
||||||
msgid "Official app website:"
|
msgid "Official app website:"
|
||||||
msgstr "Site officiel de l’app :"
|
msgstr "Site officiel de l’app :"
|
||||||
|
|
||||||
#: templates/README.md.j2:67
|
#: templates/README.md.j2:68
|
||||||
msgid "Official user documentation:"
|
msgid "Official user documentation:"
|
||||||
msgstr "Documentation officielle utilisateur :"
|
msgstr "Documentation officielle utilisateur :"
|
||||||
|
|
||||||
#: templates/README.md.j2:69
|
#: templates/README.md.j2:70
|
||||||
msgid "Official admin documentation:"
|
msgid "Official admin documentation:"
|
||||||
msgstr "Documentation officielle de l'admin :"
|
msgstr "Documentation officielle de l'admin :"
|
||||||
|
|
||||||
#: templates/README.md.j2:71
|
#: templates/README.md.j2:72
|
||||||
msgid "Upstream app code repository:"
|
msgid "Upstream app code repository:"
|
||||||
msgstr "Dépôt de code officiel de l’app :"
|
msgstr "Dépôt de code officiel de l’app :"
|
||||||
|
|
||||||
#: templates/README.md.j2:73
|
|
||||||
msgid "YunoHost Store:"
|
|
||||||
msgstr "YunoHost Store :"
|
|
||||||
|
|
||||||
#: templates/README.md.j2:74
|
#: templates/README.md.j2:74
|
||||||
msgid "Report a bug:"
|
msgid "YunoHost Store:"
|
||||||
msgstr "Signaler un bug :"
|
msgstr "YunoHost Store :"
|
||||||
|
|
||||||
#: templates/README.md.j2:76
|
#: templates/README.md.j2:75
|
||||||
|
msgid "Report a bug:"
|
||||||
|
msgstr "Signaler un bug :"
|
||||||
|
|
||||||
|
#: templates/README.md.j2:77
|
||||||
msgid "Developer info"
|
msgid "Developer info"
|
||||||
msgstr "Informations pour les développeurs"
|
msgstr "Informations pour les développeurs"
|
||||||
|
|
||||||
#: templates/README.md.j2:78
|
#: templates/README.md.j2:79
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid ""
|
msgid ""
|
||||||
"Please send your pull request to the [testing branch](%(testing_branch_url)s)"
|
"Please send your pull request to the [testing "
|
||||||
|
"branch](%(testing_branch_url)s)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Merci de faire vos pull request sur la [branche branch]"
|
"Merci de faire vos pull request sur la [branche "
|
||||||
"(%(testing_branch_url)s)"
|
"branch](%(testing_branch_url)s)"
|
||||||
|
|
||||||
#: templates/README.md.j2:81
|
#: templates/README.md.j2:82
|
||||||
msgid "To try the testing branch, please proceed like that."
|
msgid "To try the testing branch, please proceed like that."
|
||||||
msgstr "Pour essayer la branche testing, procédez comme suit."
|
msgstr "Pour essayer la branche testing, procédez comme suit."
|
||||||
|
|
||||||
#: templates/README.md.j2:89
|
#: templates/README.md.j2:86
|
||||||
|
msgid "or"
|
||||||
|
msgstr "ou"
|
||||||
|
|
||||||
|
#: templates/README.md.j2:90
|
||||||
msgid "More info regarding app packaging:"
|
msgid "More info regarding app packaging:"
|
||||||
msgstr "Plus d'infos sur le packaging d'applications :"
|
msgstr "Plus d'infos sur le packaging d'applications :"
|
||||||
|
|
||||||
|
#~ msgid "Add a `LICENSE` file for the package."
|
||||||
|
#~ msgstr "Ajoutez un fichier `LICENCE` for le paquet."
|
||||||
|
|
||||||
|
#~ msgid "Edit `doc/DISCLAIMER*.md`"
|
||||||
|
#~ msgstr "Éditez `doc/DISCLAIMER*.md`"
|
||||||
|
|
||||||
|
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading…
Reference in a new issue