Make a more detailed README for translators
authorRicardo Mones <ricardo@mones.org>
Mon, 15 Aug 2016 22:06:48 +0000 (00:06 +0200)
committerRicardo Mones <rmoneslastra@csc.com>
Tue, 16 Aug 2016 08:54:23 +0000 (10:54 +0200)
README
po/README [new file with mode: 0644]

diff --git a/README b/README
index 1f8a8a8..c843b5a 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ Clawsker - A Claws Mail Tweaker
 -------------------------------
 
 Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail,
-and to do it in a safe and user friendly way, preventing users from raw 
+and to do it in a safe and user friendly way, preventing users from raw
 editing of configuration files.
 
 Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
@@ -27,7 +27,7 @@ Dependencies
 
   Perl - http://www.perl.com (>= 5.8)
   GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net (>= 1.161) built
-  with GTK+ >= 2.12 (lower GTK+ versions do not support widget tooltips and 
+  with GTK+ >= 2.12 (lower GTK+ versions do not support widget tooltips and
   a warning is issued).
   Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
   Claws Mail - http://www.claws-mail.org (>= 3.1.0)
@@ -60,25 +60,11 @@ Optionally you can provide also a DESTDIR as a root tree for the installation.
 Contributing
 ------------
 
-Patches, bug fixes, and specially, new translations (or updates to the 
-existing ones) are welcome. Development uses git as VCS and takes place on
-http://github.com/mones/clawsker/.
-
-To create a new translation just change to 'po' directory, copy 'clawsker.pot'
-into 'xx.po' or 'xx_YY.po',  and fill the empty strings and placeholder values. 
-The 'xx' is your language code (e.g.: 'en' for English, 'fr' for French, etc.)
-and, optionally, 'YY' defines your country variant (e.g.: 'de_CH' for German
-variant in Switzerland). Country should be used only if your translation is
-really specific to that location, otherwise, and specially for new languages,
-try use the generic language (you can always submit a specific one later).
-
-Once finished you can test your new translation by adding your 'xx' or 'xx_YY'
-code to the LINGUAS variable in Makefile and running make. A new .mo file
-with the same name of your .po file should be created if everything is right.
-
-To update an existing translation just type 'make xx.pox' or 'make xx_YY.pox'
-and update the new .pox file created, copy the .pox file to the .po file and
-test it as above (no need to modify the Makefile this time).
+Patches, bug fixes, and specially, new translations (or updates to the
+existing ones) are welcome. Development uses git as VCS and takes place
+on http://github.com/mones/clawsker/.
+
+Translators please read po/README file for details about translations.
 
 Bugs
 ----
diff --git a/po/README b/po/README
new file mode 100644 (file)
index 0000000..f9a1418
--- /dev/null
+++ b/po/README
@@ -0,0 +1,64 @@
+
+Translating Clawsker - A Claws Mail Tweaker
+-------------------------------------------
+
+If you want to contribute a translation or update send it directly to
+me: ricardo@mones.org
+
+If you have questions or just want to get in touch with other
+translators of the project you can subscribe to the Claws Mail
+translators' mailing list:
+http://lists.claws-mail.org/cgi-bin/mailman/listinfo/translators
+
+New translations
+~~~~~~~~~~~~~~~~
+
+To create a new translation just change to 'po' directory, copy the
+'clawsker.pot' file into 'xx.po' or 'xx_YY.po', and fill the empty
+strings and placeholder values (strings in CAPS). See how is done
+in other translations for example.
+
+The pot file can be obtained from a git clone or a release tarball.
+
+The 'xx' is your language code (e.g.: 'en' for English, 'fr' for
+French, etc.) and, optionally, 'YY' defines your country variant
+(e.g.: 'de_CH' for German variant in Switzerland).
+
+Country should be used only if your translation is really specific to
+that location, otherwise, and specially for new languages, try use the
+generic language (you can always submit a specific one later).
+
+Updating existing translation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To update an existing translation just type 'make xx.pox' or 'make
+xx_YY.pox' to merge changes in pot file.
+
+Update the new .pox file created and copy the .pox file into
+the .po file.
+
+If you intend to update a translation made by other and it has been
+recently updated it's probably a good idea to contact first with last
+translator.
+
+Testing a translation
+~~~~~~~~~~~~~~~~~~~~~
+
+Once finished the new translation or the update you should test your
+translation.
+
+New translations need adding your 'xx' or 'xx_YY' code to the LINGUAS
+variable in Makefile. Existing translation already have it.
+
+Then type 'make'. A new .mo file with the same name of your .po file
+should be created if everything is right.
+
+Translations not maintained
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If a translation is not updated in several releases and the number of
+translated strings drops below certain level it will be moved to the
+directory 'po/unmaint'. Check there before making a new translation.
+
+These translations will be also included in release tarballs but won't
+be built or installed.