Add more technical information to README.rst

parent 881c834f
......@@ -7,6 +7,7 @@ in progress
===========
- Convert fr, en and de to i18next JSON format
- Rename gafam.pot to gafam-poster.pot
- Add more technical information to README.rst
2018-01-12 0.1.0
================
......
......@@ -22,13 +22,63 @@ Contributions are always welcome!
How to work with it
===================
Add another translation
-----------------------
You can find a nice description about how to get started
with translations at https://gafam.info/#contribute.
Thanks for your efforts!
Technical guideline for operators
=================================
If you are used to work on the command line,
these informations might help you along.
Add a new translation file
--------------------------
::
cd po
msginit --locale pt
This should add a new translation file ``pt.po``.
Please edit the header fields ``Last-Translator``
and ``Language-Team`` appropriately. Then, add
the translation texts.
You might want to have a look at the existing
translations as a reference, especially about
how to handle multiline items:
`<po/fr.po>`_, `<po/en.po>`_, `<po/de.po>`_ and
`<po/jp.po>`_.
Convert translation file formats
--------------------------------
Convert GNU gettext PO files to i18next_ JSON format::
yarn install
make gettext-to-json
This should convert all ``po/*.po`` files to their
corresponding ``json/*.json`` pendants.
It uses the `i18next-gettext-converter`_ module under the hood.
.. note::
As the JSON files will be automatically generated from
the PO files, there's no need to edit/update them when
adding/correcting a translation for a specific language.
Just run the command above to build the JSON files
from the PO files.
.. _i18next: https://www.i18next.com/
.. _i18next-gettext-converter: https://github.com/i18next/i18next-gettext-converter
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment