l10n: README: document git-po-helper
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>
Bagas Sanjaya committed
Mar 11, 2021 at 17:57 UTC
6d09c53001491f67437b2f3ac8b16db86bfd4de1
1 file changed
+31
po/README.md
+31
@@ -286,3 +286,34 @@ Testing marked strings
286
287
Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
288
changed to account for translations as they're added.
289
+
290
+
291
+PO helper
292
+---------
293
+
294
+To make the maintenance of XX.po easier, the l10n coordinator and l10n
295
+team leaders can use a helper program named "git-po-helper". It is a
296
+wrapper to gettext suite, specifically written for the purpose of Git
297
+l10n workflow.
298
+
299
+To build and install the helper program from source, see
300
+[git-po-helper/README][].
301
+
302
+Usage for git-po-helper:
303
+
304
+ - To start a new language translation:
305
+
306
+ git-po-helper init XX.po
307
+
308
+ - To update your XX.po file:
309
+
310
+ git-po-helper update XX.po
311
+
312
+ - To check commit log and syntax of XX.po:
313
+
314
+ git-po-helper check-po XX.po
315
+ git-po-helper check-commits
316
+
317
+Run "git-po-helper" without arguments to show usage.
318
+
319
+[git-po-helper/README]: https://github.com/git-l10n/git-po-helper#readme