Clawsker - A Claws Mail Tweaker
-------------------------------
-Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail.
+Clawsker is a Perl-GTK applet to edit hidden preferences for Claws Mail,
+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.
+You can download the latest version from Clawsker homepage:
+
+ http://www.claws-mail.org/clawsker.php
+
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 and derivatives:
+ # apt-get install make sed coreutils gettext perl
+ (Although you probably already have some of these installed)
+
+ - Running:
+
+ Perl - http://www.perl.com (>= 5.10)
+ GTK+3 bindings for Perl - https://gitlab.gnome.org/GNOME/perl-gtk3
+ (>= 0.030)
+ Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
+ File::Which - https://metacpan.org/pod/File::Which (>= 1.21)
+ Claws Mail - http://www.claws-mail.org (>= 3.9.1)
+
+ On Debian systems:
+ # apt-get install libgtk3-perl liblocale-gettext-perl libfile-which-perl
+ # apt-get install claws-mail
+
+ - Test suite:
+
+ Test::More - https://metacpan.org/pod/Test::More
+ Test::Output - https://metacpan.org/pod/Test::Output
+ Test::Exception - https://metacpan.org/pod/Test::Exception
+ Test::NeedsDisplay - https://metacpan.org/pod/Test::NeedsDisplay
Install
-------
After downloading the tarball:
- tar xzf clawsker-VERSION.tar.gz
- cd clawsler-VERSION
+ tar xJf clawsker-VERSION.tar.xz
+ cd clawsker-VERSION
+ make
+
+If finished correctly, become root and:
+
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.
+
+Test suite
+----------
+
+You can run the test suite with:
+
+ make test
+
+If running test suite fails please report a bug with all the messages
+printed by the above command, the versions of Perl and the version of
+Clawsker dependencies you're using.
+
+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://git.claws-mail.org.
+
+Translators please read po/README file for details about translations.
+
+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
+* GitHub Inc., for providing the initial git hosting and more
+
+[0] http://gtk2-perl.sourceforge.net/doc/gtk2-perl-study-guide/
+--