Make it a module
[clawsker.git] / 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 Install
40 -------
41
42 After downloading the tarball:
43
44   tar xJf clawsker-VERSION.tar.xz
45   cd clawsker-VERSION
46   make
47
48 If finished correctly, become root and:
49
50   make install
51
52 Replace VERSION with the actual version number of the tarball.
53
54 Default install is under /usr/local prefix. If you want to install in another
55 location (for example /usr) replace last line with:
56
57   make install PREFIX=/usr
58
59 Optionally you can provide also a DESTDIR as a root tree for the installation.
60
61 Contributing
62 ------------
63
64 Patches, bug fixes, and specially, new translations (or updates to the
65 existing ones) are welcome. Development uses git as VCS and takes place
66 on http://git.claws-mail.org.
67
68 Translators please read po/README file for details about translations.
69
70 Bugs
71 ----
72
73 You can send bug reports to http://www.thewildbeast.co.uk/claws-mail/bugzilla/
74 by selecting the 'clawsker' product.
75
76 Also directly by mail to me or in the Claws Mail mailing list, but bugzilla
77 is the preferred way.
78
79 Thanks
80 ------
81
82 * The Claws Mail Team, for such great mail program
83 * Larry Wall and all Perl hackers all over the world
84 * The Perl-GTK2 folks and Phillip Vandry
85 * Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
86 * Debian, for the Operating System
87 * GitHub Inc., for providing the initial git hosting and more
88
89 [0] http://gtk2-perl.sourceforge.net/doc/gtk2-perl-study-guide/
90
91 --