diff --git a/README.md b/README.md index 8601c094d..e757fb808 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This is the content repository for [jamulus.io](https://jamulus.io). Text appear Translation status + The Jamulus website is translated using [Weblate](https://hosted.weblate.org/engage/jamulus/). If you prefer you may also submit translations via Pull Requests. Note that translating the Jamulus application itself is done by a different process, but you are welcome to help with that too. Introduce yourself on the [GitHub Discussion](https://github.com/jamulussoftware/jamulus/discussions) and say what you’d like to do. ***PLEASE NOTE:*** Discussions should be in English so as to be open to all. diff --git a/_translator-files/README.md b/_translator-files/README.md index 3819f73f5..e0c9963fe 100644 --- a/_translator-files/README.md +++ b/_translator-files/README.md @@ -2,7 +2,7 @@ The recommended way to translate the website documentation is by using [Weblate](https://hosted.weblate.org/projects/jamulus/). If you are comfortable using GitHub and .po file editors, and still want to contribute your translation via a Pull Request, the files for each language are contained in: `_translator-files/po/LANGUAGE/`. You can find a guide on .po file editors [here](https://jamulus.io/kb/2022/08/04/Translating-po-files.html). Please make your PR against the `next-release` branch. -#####Some tips regarding translations: +**Some tips regarding translations:** - Change the `lang: en` parameter in the files containing it at the beginning of the file to your language code (it, fr, de, etc.) and make sure the `permalink: [parameter]` (e.g. /wiki/Client-Troubleshooting) stays the same. - At times there are links to other docs or specific paragraphs in other parts of the website: `[translate this](don't translate this#translate-this-but-don't-use-capitals)`. Make sure the last part uses the exact same words as the relevant paragraph title. @@ -10,7 +10,7 @@ The recommended way to translate the website documentation is by using [Weblate] - There are documents containing portions of text that do not require translation, e.g. scripts, links, etc. In these cases, please do not leave the translation field empty, but copy the source text into the translation field. - Pull Requests for translations should have a title which looks like this: `Update [lang] web translation for [release number]` -#### Please note: if your language has no translated documents, please start with the following: +**Please note: if your language has no translated documents, please start with the following:** - 1-index.po - general.po @@ -27,4 +27,4 @@ Open an issue ([here](https://github.com/jamulussoftware/jamuluswebsite/issues)) - Lower case if it is a two-character code (e.g. "Add Basque [eu]") - Lower case + underscore + upper case for regional variations (e.g. "Add Brazilian Portuguese [pt_BR]"). -You will be notified on the issue thread you opened when the language files have been created. You can then work on the translations. \ No newline at end of file +You will be notified on the issue thread you opened when the language files have been created. You can then work on the translations.