]> git.ipfire.org Git - thirdparty/git.git/commitdiff
l10n: README: document git-po-helper
authorBagas Sanjaya <bagasdotme@gmail.com>
Thu, 11 Mar 2021 10:57:15 +0000 (17:57 +0700)
committerJiang Xin <worldhello.net@gmail.com>
Wed, 2 Jun 2021 03:21:26 +0000 (11:21 +0800)
Document the PO helper program (git-po-helper) with installation and
basic usage.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Jiang Xin <worldhello.net@gmail.com>
po/README.md

index efd5baaf1d84e511eabf8988aa78361a2b19b626..cafb5cf365efee580c884e92aaab414dda002f7b 100644 (file)
@@ -286,3 +286,34 @@ Testing marked strings
 
 Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
 changed to account for translations as they're added.
+
+
+PO helper
+---------
+
+To make the maintenance of XX.po easier, the l10n coordinator and l10n
+team leaders can use a helper program named "git-po-helper". It is a
+wrapper to gettext suite, specifically written for the purpose of Git
+l10n workflow.
+
+To build and install the helper program from source, see
+[git-po-helper/README][].
+
+Usage for git-po-helper:
+
+  - To start a new language translation:
+
+        git-po-helper init XX.po
+
+  - To update your XX.po file:
+
+        git-po-helper update XX.po
+
+  - To check commit log and syntax of XX.po:
+
+        git-po-helper check-po XX.po
+        git-po-helper check-commits
+
+Run "git-po-helper" without arguments to show usage.
+
+[git-po-helper/README]: https://github.com/git-l10n/git-po-helper#readme