From 7d9be35200edb05c0f152065c2246228bf11dc6a Mon Sep 17 00:00:00 2001 From: matograine <matograine@zaclys.net> Date: Wed, 20 Apr 2022 23:00:39 +0200 Subject: [PATCH] enhance README.md with new script abilities --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5c4c683..8f7a952 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,13 @@ Pour construire un site ViĞnette avec ses traductions, on exécute le script de `python3 build.py` +On peut lui passer de zéro à deux arguments : + +`python3 build.py <url_orientation> <default_lang>` + +- `url_orientation` peut être "horizontal", "vertical" ou "none". La valeur par défaut est "horizontal". Il définit l'orientation de l'URL sur les ViGnettes. +- `default_lang` va automatiquement créer une page par défaut dans la langue indiquée. Il doit correspondre à une des langues présentes dans i18n. + ## Traduction Les fichiers de traduction doivent se trouver dans `i18n` suivant ce schéma: @@ -56,6 +63,14 @@ To build the site with the translations : `python3 build.py` +It takes zero to two arguments: + +`python3 build.py <url_orientation> <default_lang>` + +- `url_orientation` can be "horizontal", "vertical" or "none". Default is "horizontal". It rules the orientation of URL on vignettes. +- `default_lang` will automatically create a homepage in given language. It must match one lang existing in i18n. + + ## Translation Translation files must be located in dir `i18n` and follow this schema: -- GitLab