1# Translating Solaar
2
3First, make sure you have installed the `gettext` package.
4
5Here are the steps to add/update a translation (you should run all scripts from
6the source root):
7
81. Get an up-to-date copy of the source files. Preferrably, make a clone on
9   GitHub and clone it locally on your machine; this way you can later make a
10   pull request to the main project.
11
122. Run `./tools/po-update.sh <language>`; it will create/update the file
13   `./po/<language>.po`.
14
153. Edit `./po/<language>.po` with your favourite editor (just make sure it saves
16   the file with the UTF-8 encoding). For each string in english (msgid), edit
17   the translation (msgstr); if you leave msgstr empty, the string will remain
18   untranslated.
19
20   Alternatively, you can use the excellent `poedit`.
21
224. Run `./tools/po-compile.sh`. It will bring up-to-date all the compiled
23   language files, necessary at runtime.
24
255. Start Solaar (`./bin/solaar`). By default it will pick up the system languge
26   from your environment; to start it in another language, run
27   `LANGUAGE=<language> ./bin/solaar`.
28
29You can edit the translation iteratively, just repeat from step 3.
30If the upstream changes, do a `git pull` and then repeat from step 2.
31
32Before opening a pull request, please run `./tools/po-update.sh` again. It will
33format and sort the translation file, and ensure a minimal diff when updating
34a translation.
35
36
37# Supported languages
38
39Currently Solaar has been translated in the following languages:
40
41- Français: [Papoteur][papoteur], [David Geiger][david-geiger],
42  [Damien Lallement][damsweb]
43- Italiano: [Michele Olivo][micheleolivo]
44- Polski: [Adrian Piotrowicz][nexces]
45- Portuguese-BR: [Drovetto][drovetto], [Josenivaldo Benito Jr.][jrbenito]
46- Română: Daniel Pavel
47- Russian: [Dimitriy Ryazantcev][DJm00n]
48- Svensk: [Daniel Zippert][zipperten], Emelie Snecker
49
50[papoteur]: http://github.com/papoteur
51[david-geiger]: http://github.com/david-geiger
52[damsweb]: http://github.com/damsweb
53[DJm00n]: https://github.com/DJm00n
54[nexces]: http://github.com/nexces
55[zipperten]: http://github.com/zipperten
56[micheleolivo]: http://github.com/micheleolivo
57[drovetto]: https://github.com/drovetto
58[jrbenito]: https://github.com/jrbenito/
59