contributing section, pot package details

[clawsker.git] / README

diff --git a/README b/README
index 2091895bdd92d2af99ebcdbf75f21d1af221935a..79ceee5b5d3da486a49e4ed1f094bde5e6eb6251 100644 (file)
--- a/README
+++ b/README
@@ -32,10 +32,11 @@ Dependencies
 Install
 -------
 
-After downloading the tarball:
+After downloading the tarball, as root:
 
   tar xzf clawsker-VERSION.tar.gz
-  cd clawsler-VERSION
+  cd clawsker-VERSION
+  make
   make install
 
 Replace VERSION with the actual version number of the tarball.
@@ -45,6 +46,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, and specially, new translations (or updates to th existing) 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
 ------