Add documentation for translations

This commit is contained in:
Markus Frosch 2021-01-03 19:51:31 +01:00
parent 1cb150514b
commit 65c7cf330e
3 changed files with 60 additions and 1 deletions

View File

@ -65,7 +65,8 @@ Any help is welcome with the Terminator project.
* [Open issues for bugs or enhancements](https://github.com/gnome-terminator/terminator/issues/new) * [Open issues for bugs or enhancements](https://github.com/gnome-terminator/terminator/issues/new)
* [Join our chat room on gitter.im for general questions](https://gitter.im/gnome-terminator/community) * [Join our chat room on gitter.im for general questions](https://gitter.im/gnome-terminator/community)
* * [Help translating Terminator](TRANSLATION.md)
You can find old bugs and questions in the launchpad project, but please don't post anything new there. You can find old bugs and questions in the launchpad project, but please don't post anything new there.
* https://answers.launchpad.net/terminator * https://answers.launchpad.net/terminator

View File

@ -26,6 +26,12 @@ dos2unix CHANGELOG.md
Check and review CHANGELOG.md for the expected result. Check and review CHANGELOG.md for the expected result.
## Review and update translations
Check for open pull-requests by Transifex or pull the files manually.
See [TRANSLATION](TRANSLATION.md).
## Update AUTHORS ## Update AUTHORS
This will make sure we mention everyone that has contributed to Terminator. This will make sure we mention everyone that has contributed to Terminator.

52
TRANSLATION.md Normal file
View File

@ -0,0 +1,52 @@
# Translation
Terminator has been translated to multiple languages and locales, but there is always
work to do, so everyone is welcome to help and contribute.
You can find all translations under the `po` directory, which will be compiled and
installed with Terminator.
Translations are managed on Transifex [transifex.com/terminator],
anyone is free to join the project and start translating.
You should read the [Getting Started as a Translator] guide.
_Questions or problems?_ Please reach out on [Gitter] or [open an issue].
## Updating POT
The POT file is the template for all translations and is generated from the Python
source code.
cd po/
./genpot.sh
git diff terminator.pot
To generate and handle POT and PO files, you will need at least `gettext` and `intltool` installed.
Usually the POT file is automatically synced to Transifex, but it can be manually pushed:
tx push --source
## Updating Translations
Transifex is configured to automatically open a pull-request when a language has been
fully translated. A manual update is always possible and might be useful when preparing
a release.
tx pull --all
You can also push translations changed outside of Transifex back to the service:
tx push --translations --language XX
## External Documentation
* [Getting Started as a Translator]
* [Transifex CLI Client](https://docs.transifex.com/client/introduction)
* [Documentation Overview](https://docs.transifex.com/)
[Gitter]: https://gitter.im/gnome-terminator/community
[open an issue]: https://github.com/gnome-terminator/terminator/issues/new/choose
[transifex.com/terminator]: https://www.transifex.com/terminator/terminator/dashboard/
[Getting Started as a Translator]: https://docs.transifex.com/getting-started-1/translators