README.md
1DeforaOS Mailer
2===============
3
4About Mailer
5------------
6
7Mailer is a mail client application for the DeforaOS desktop.
8
9Mailer is part of the DeforaOS Project, and distributed under the terms of the
10GNU General Public License, version 3 (GPLv3).
11
12
13Compiling Mailer
14----------------
15
16Mailer depends on the following components:
17
18 * Gtk+ 2 or 3
19 * OpenSSL
20 * DeforaOS libDesktop
21
22With GCC, this should then be enough:
23
24 $ make
25
26To install (or package) Mailer in a different location:
27
28 $ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
29
30
31Documentation
32-------------
33
34Manual pages for each of the executables installed are available in the `doc`
35folder. They are written in the DocBook-XML format, and need libxslt and
36DocBook-XML to be installed to be converted to either HTML or man file format.
37
38Likewise, the API reference for libMailer (accounts and plug-ins) is available
39in the `doc/gtkdoc` folder, and is generated using gtk-doc.
40