Clawsker - A Claws Mail Tweaker
-------------------------------
-Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail.
+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.
+
Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
Dependencies
------------
- Perl - http://www.perl.com
- GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net
- Claws Mail - http://www.claws-mail.org
+ - Building:
+
+ Nothing special: make, sed, install, gettext and pod2man.
+
+ On Debian systems:
+ # apt-get install make sed coreutils gettext perl
+ (Although you probably already have some of these installed)
+
+ - Running:
+
+ Perl - http://www.perl.com (>= 5.8)
+ GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net (>= 1.140)
+ Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
+ Claws Mail - http://www.claws-mail.org (>= 3.1.0)
+
+ On Debian systems:
+ # apt-get install libgtk2-perl liblocale-gettext-perl claws-mail
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.
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
+------
+
+* The Claws Mail Team, for such great mail program
+* Larry Wall and all Perl hackers all over the world
+* The Perl-GTK2 folks and Phillip Vandry
+* Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
+* Debian, for the Operating System
+
+[0] http://forgeftp.novell.com//gtk2-perl-study/documentation/html/index.html
+
+--
+$Id$