Fix required/supported versions
[clawsker.git] / README
1
2 Clawsker - A Claws Mail Tweaker
3 -------------------------------
4
5 Clawsker is a Perl-GTK2 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+2 bindings for Perl - http://gtk2-perl.sourceforge.net (>= 1.161) built
30   with GTK+ >= 2.12 (lower GTK+ versions do not support widget tooltips and
31   a warning is issued).
32   Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
33   Claws Mail - http://www.claws-mail.org (>= 3.9.1)
34
35   On Debian systems:
36   # apt-get install libgtk2-perl liblocale-gettext-perl claws-mail
37
38 Install
39 -------
40
41 After downloading the tarball:
42
43   tar xJf clawsker-VERSION.tar.xz
44   cd clawsker-VERSION
45   make
46
47 If finished correctly, become root and:
48
49   make install
50
51 Replace VERSION with the actual version number of the tarball.
52
53 Default install is under /usr/local prefix. If you want to install in another
54 location (for example /usr) replace last line with:
55
56   make install PREFIX=/usr
57
58 Optionally you can provide also a DESTDIR as a root tree for the installation.
59
60 Contributing
61 ------------
62
63 Patches, bug fixes, and specially, new translations (or updates to the
64 existing ones) are welcome. Development uses git as VCS and takes place
65 on http://github.com/mones/clawsker/.
66
67 Translators please read po/README file for details about translations.
68
69 Bugs
70 ----
71
72 You can send bug reports on http://github.com/mones/clawsker/issues/ list.
73 Also directly by mail to me or in the Claws Mail mailing list, but the Issues
74 list is the preferred way.
75
76 Thanks
77 ------
78
79 * The Claws Mail Team, for such great mail program
80 * Larry Wall and all Perl hackers all over the world
81 * The Perl-GTK2 folks and Phillip Vandry
82 * Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
83 * Debian, for the Operating System
84 * GitHub Inc., for providing the git hosting and more
85
86 [0] http://gtk2-perl.sourceforge.net/doc/gtk2-perl-study-guide/
87
88 --