From 3f4fa84b7d4ff76d4e8bd8bfedd94e079e08bbce Mon Sep 17 00:00:00 2001 From: Markus Frosch Date: Mon, 18 May 2020 00:03:44 +0200 Subject: [PATCH] Add documentation for development For now just i18n. --- DEVELOPMENT.md | 27 +++++++++++++++++++++++++++ TRANSLATIONS.md | 7 ------- 2 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 DEVELOPMENT.md delete mode 100644 TRANSLATIONS.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 00000000..3cc214b9 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,27 @@ +Development Notes +================= + +Here we connect notes and howtos for development around Terminator. Feel free to extend or submit suggestions. + +## Translation i18n + +Tooling is based on [Babel](https://babel.pocoo.org), the configuration is stored in `babel.cfg`, `setup.cfg` and +some code in `setup.py`. + +The POT file [po/terminator.pot](po/terminator.pot) contains the template for all translations and should be updated +regularly, especially when messages changed inside the source code. + +``` +$ python setup.py extract_messages +``` + +Usually catalogs are updated with external translation tools, e.g. when new translations are merged. But we can update +the catalogs here, so translators will have it more easy to pick up their work. +This is a custom extension in `setup.py`. + +``` +$ python setup.py update_catalogs +``` + +Compilation of catalogs into the binary form, from `*.po` to `*.mo` is done during `setup.py build`, and the files are +installed during `setup.py install`. diff --git a/TRANSLATIONS.md b/TRANSLATIONS.md deleted file mode 100644 index 8f441c61..00000000 --- a/TRANSLATIONS.md +++ /dev/null @@ -1,7 +0,0 @@ -### Translating Terminator into your language - -Localized strings are available in po/.po. These files are compiled -into .mo files by running `python setup.py build` - -If you've added a new localized string to the source code, it needs to be -extracted to `po/terminator.pot` by running `python setup.py extract_messages`