fix warning when no LANG/LC_MESSAGES

[clawsker.git] / README

diff --git a/README b/README
index 784fc4b5be04d2bfeafaed40041264693953f7e0..359f387cb4fe76708bd5ddbb7528559e46849fad 100644 (file)
--- a/README
+++ b/README
@@ -4,19 +4,23 @@ 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 
-edition of configuration files.
+editing of configuration files.
 
 Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
 
+You can download the latest version from Clawsker homepage:
+
+  http://www.claws-mail.org/clawsker
+
 Dependencies
 ------------
 
   - Building:
 
-  Nothing special: make, sed, install and pod2man.
+  Nothing special: make, sed, install, gettext and pod2man.
 
   On Debian systems:
-  # apt-get install make sed coreutils perl
+  # apt-get install make sed coreutils gettext perl
   (Although you probably already have some of these installed)
 
   - Running:
@@ -35,7 +39,11 @@ Install
 After downloading the tarball:
 
   tar xzf clawsker-VERSION.tar.gz
-  cd clawsler-VERSION
+  cd clawsker-VERSION
+  make
+
+If finished correctly, become root and:
+
   make install
 
 Replace VERSION with the actual version number of the tarball.
@@ -45,6 +53,29 @@ location (for example /usr) replace last line with:
 
   make install PREFIX=/usr
 
+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.
+
+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).
 
 Thanks
 ------