README

   1
   2 Clawsker - A Claws Mail Tweaker
   3 -------------------------------
   4
   5 Clawsker is a Perl-GTK applet to edit hidden preferences for Claws Mail,
   6 and to do it in a safe and user friendly way, preventing users from raw
   7 editing of configuration files.
   8
   9 Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
  10
  11 You can download the latest version from Clawsker homepage:
  12
  13   http://www.claws-mail.org/clawsker.php
  14
  15 Dependencies
  16 ------------
  17
  18   - Building:
  19
  20   Nothing special: make, sed, install, gettext and pod2man.
  21
  22   On Debian systems and derivatives:
  23   # apt-get install make sed coreutils gettext perl
  24   (Although you probably already have some of these installed)
  25
  26   - Running:
  27
  28   Perl - http://www.perl.com (>= 5.10)
  29   GTK+3 bindings for Perl - https://gitlab.gnome.org/GNOME/perl-gtk3
  30   (>= 0.030)
  31   Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
  32   File::Which - https://metacpan.org/pod/File::Which (>= 1.21)
  33   Claws Mail - http://www.claws-mail.org (>= 3.9.1)
  34
  35   On Debian systems:
  36   # apt-get install libgtk3-perl liblocale-gettext-perl libfile-which-perl
  37   # apt-get install claws-mail
  38
  39   - Test suite:
  40
  41   Test::Exception - https://metacpan.org/pod/Test::Exception
  42
  43 Install
  44 -------
  45
  46 After downloading the tarball:
  47
  48   tar xJf clawsker-VERSION.tar.xz
  49   cd clawsker-VERSION
  50   make
  51
  52 If finished correctly, become root and:
  53
  54   make install
  55
  56 Replace VERSION with the actual version number of the tarball.
  57
  58 Default install is under /usr/local prefix. If you want to install in another
  59 location (for example /usr) replace last line with:
  60
  61   make install PREFIX=/usr
  62
  63 Optionally you can provide also a DESTDIR as a root tree for the installation.
  64
  65 Test suite
  66 ----------
  67
  68 You can run the test suite with:
  69
  70   make test
  71
  72 If running test suite fails please report a bug with all the messages
  73 printed by the above command, the versions of Perl and the version of
  74 Clawsker dependencies you're using.
  75
  76 Contributing
  77 ------------
  78
  79 Patches, bug fixes, and specially, new translations (or updates to the
  80 existing ones) are welcome. Development uses git as VCS and takes place
  81 on http://git.claws-mail.org.
  82
  83 Translators please read po/README file for details about translations.
  84
  85 Bugs
  86 ----
  87
  88 You can send bug reports to http://www.thewildbeast.co.uk/claws-mail/bugzilla/
  89 by selecting the 'clawsker' product.
  90
  91 Also directly by mail to me or in the Claws Mail mailing list, but bugzilla
  92 is the preferred way.
  93
  94 Thanks
  95 ------
  96
  97 * The Claws Mail Team, for such great mail program
  98 * Larry Wall and all Perl hackers all over the world
  99 * The Perl-GTK2 folks and Phillip Vandry
 100 * Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
 101 * Debian, for the Operating System
 102 * GitHub Inc., for providing the initial git hosting and more
 103
 104 [0] http://gtk2-perl.sourceforge.net/doc/gtk2-perl-study-guide/
 105
 106 --