From 97aef8309cde4e1007451ecb72178ec029ef7707 Mon Sep 17 00:00:00 2001 From: Damien Goutte-Gattat Date: Mon, 23 May 2011 00:51:54 +0200 Subject: [PATCH] Add README file --- Makefile.am | 2 +- README | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 README diff --git a/Makefile.am b/Makefile.am index 41eed6e..c0c6f41 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,4 +2,4 @@ SUBDIRS = lib src man ACLOCAL_AMFLAGS = -I m4 --install -dist_doc_DATA = AUTHORS COPYING +dist_doc_DATA = AUTHORS COPYING README diff --git a/README b/README new file mode 100644 index 0000000..3ef3174 --- /dev/null +++ b/README @@ -0,0 +1,44 @@ +fmail - Incenp.org’s mail formatter +=================================== + +Description +----------- +Fmail is a mail formatter. It reads a draft message on its standard +input and writes to its standard output a suitably formatted message +ready to be sent to a mail submission agent. + +The name “fmail” stands for something like “Formatting MAIL”. + + +Copying +------- +Fmail is distributed under the terms of the GNU General Public License +(see COPYING file). Source code and other informations are available on +. + + +Homepage and contact +-------------------- +The latest source code, the repository and some informations are +available at . + +Contact: Damien Goutte-Gattat + + +Install +------- +Fmail depends on the following libraries: + + – libgpgme , to sign messages; + + – libmagic , to guess file type and + encoding of attachments. + +I expect Fmail to compile cleanly (and behave correctly) on most POSIX +systems, although I have only tested it on my GNU/Linux box. Should you +find a portability issue on your system, please let me know. + +Run the provided “configure” script to prepare the sources for build; +run “configure --help” to know the available configuration parameters. +Then run “make” to effectively build the program, and “make install” to +install it on your system.