diff --git a/README.i18n.md b/README.i18n.md index f11fa975..89187ef5 100644 --- a/README.i18n.md +++ b/README.i18n.md @@ -1,27 +1,34 @@ # Colobot data translation The translation of Colobot level titles, level hierarchy and help files -is managed through [gettext](https://www.gnu.org/software/gettext/). +is managed through translation files (`*.pot` and `*.po`) as those generated by +[gettext](https://www.gnu.org/software/gettext/). This is achieved by +a set of Python scripts using [polib library](https://pypi.python.org/pypi/polib). + +The only requirement for generating translations is standard Python 2.6+ installation +(polib library is bundled with other script files). If you don't have Python +installed, nothing is generated and only English files are installed. ## Level scene description files -Level scene description files have english headers that are used in the +Level scene description files have English headers that are used in the Colobot interface to describe the levels. Level scene description files -are levels/$level/scene.txt and translations are handled in the -level-specific po/ directory: levels/$levels/po/. The .pot file is the -source translation file, the *.po files are the translations. +are `levels/$level/scene.txt` and translations are handled in the +level-specific `po/` directory: `levels/$levels/po/`. The `*.pot` file is the +source translation file, the `*.po` files are the translations. ## Help files -Helpfiles are divided in two categories: -* Generic helpfiles, about the game, the objects, the syntax, etc. These - are stored in help/ , in four sub-categories: generic, bots, object - and bots. -* Level-specific helpfiles, about the level, instructions, example - programs, etc. These are stored in levels/$level/help/. +Help files are divided in two categories: + * Generic help files, about the game, the objects, the syntax, etc. These + are stored in `help/`, in four sub-categories: generic, bots, object + and bots. + * Level-specific help files, about the level, instructions, example + programs, etc. These are stored in `levels/$level/help/`. -Helpfiles have their source in english, always stored in the E/ -subdirectory. Every other language directory is dynamically generated in the build process from files in level's po/ directory. +Help files have their source in English, always stored in the `E/` +subdirectory. Every other language directory is dynamically generated +in the build process from files in level's `po/` directory. ## Colobot syntax