Update TRANSLATORS docs to advertize Git-oriented patch submission workflow
authorAlexandre Prokoudine <alexandre.prokoudine@gmail.com>
Mon, 16 May 2016 21:56:19 +0000 (00:56 +0300)
committerRobin Gareus <robin@gareus.org>
Mon, 16 May 2016 22:07:33 +0000 (00:07 +0200)
TRANSLATORS

index 26211adae6c2b26fbccfba30279615a39c18a2b0..f0ab4d288ae64181a36afe5bc836b9ff85490fbc 100644 (file)
@@ -22,7 +22,7 @@ showing the case for Russian):
 libs/gtkmm2ext/po/ru.po
 
 Every PO file's name is a two-character code, e.g. 'de' for German, 'es' for
-Spanish and so on. However it's fairly common to have localizations for local
+Spanish, and so on. However it's fairly common to have localizations for local
 versions of a language, e.g. 'pt_BR' would stand for Brazilian Portuguese, and
 'es_MX' would stand for Mexican Spanish. Please refer to ISO language code
 table for details.
@@ -30,22 +30,47 @@ table for details.
 Here is the best workflow for existing translations.
 
 1. Build Ardour  using './waf' command (this step is actually optional).
+
 2a. If there is no existing translation for your language, run './waf i18n_pot'
 which will generate a POT (.pot) file for each of the directories shown
-above. For each directory you plan to translate, rename the POT file to end in .po and then
-continue with step 3.
+above. For each directory you plan to translate, rename the POT file to end in 
+.po and then continue with step 3.
+
 2b. If there is an existing translation for your language, run './waf
 i18n_pot' which will bring it up to date (along with all other PO files)
+
 3. Open the relevant PO file in you PO editor of choice (see below).
-4. Open Ardour, find something untranslated, locate this phrase in PO file, translate.
+
+4. Open Ardour, find something untranslated, locate this phrase in PO file, 
+translate.
+
 5. Repeat previous step several times, save the PO file.
-6. Run './waf i18n_mo' to regenerate binary MO files and 'sudo ./waf install' to install them.
-7. Restart Ardour to see what your translation looks like and whether it needs fixes, e.g. has to be shorter.
 
-Note that as of Ardour 3 beta 1 the translations are only installed when you
-run './waf i18n' after './waf' and before 'sudo ./waf install'.
+6. Run './waf i18n_mo' to regenerate binary MO files and 'sudo ./waf install' 
+to install them.
+
+7. Restart Ardour to see what your translation looks like and whether it needs 
+fixes, e.g. has to be shorter.
+
+Note that as of Ardour 4 the translations are only installed when you run 
+'./waf i18n' after './waf' and before 'sudo ./waf install'.
+
+When you are done translating, it's best to get credited for your contribution. 
+Here is how you can do it:
+
+1. Run 'git commit -a' (assuming you only modified translation files) and 
+describe the changes you made. Typically the commit message looks like 
+'Update German translation'. That should be sufficient.
+
+2. Run 'git format-patch origin/master' (assuming you worked on a clone of the 
+master branch. That should generate a file called something like 
+'0001-Update-German-translation.patch'.
+
+3. Run 'bzip2 0001-Update-German-translation.patch' to compress the file.
 
-When you are done, save the file and submit it to the tracker.
+4. File a new bug report at http://tracker.ardour.org and attach the resulted 
+compressed file and tell either rgareus (Robin Gareus) or las (Paul David) on 
+the project's IRC channel (#ardour at irc.freenode.net) about your patch.
 
 There are some more things you need to know.