tAdd README file - scribo - Email-based phlog generator
 (HTM) git clone git://git.z3bra.org/scribo.git
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
 (DIR) commit e3e9057cb649b0bcb76dc85fc3181cd0c7235260
 (DIR) parent a35f45347a0de649383b37c35fee3aceb7596072
 (HTM) Author: Willy Goiffon <dev@z3bra.org>
       Date:   Thu, 10 Sep 2020 00:01:32 +0200
       
       Add README file
       
       Diffstat:
         A README                              |      44 +++++++++++++++++++++++++++++++
       
       1 file changed, 44 insertions(+), 0 deletions(-)
       ---
 (DIR) diff --git a/README b/README
       t@@ -0,0 +1,44 @@
       +scribo
       +======
       +Email-based phlog generator.
       +
       +Upon receiving an email, a new log entry is created, and a gopher index
       +file generated from the list of files already present.
       +
       +All you need to create a new phlog entry, is to send an email !
       +
       +scribo(1) is meant to be called by an SMTP daemon, preferably from an
       +aliases(5) file. The emails are then passed to the program on STDIN,
       +which will in turn write its output files (log entry + gopher index)
       +to a specific directory.
       +
       +The log entries are written in a file derived from the "Subject" and
       +timestamped at end of file, based on the "Date" header.
       +
       +Installation
       +------------
       +Edit the `config.mk` file to match your setup, then run the following:
       +
       +        $ make
       +        # make install
       +
       +Usage
       +-----
       +Refer to the scribo(1) and aliases(5) manpage for details and examples.
       +The below commands are provided as a quick introduction.
       +
       +Add the following to you aliases(5) file:
       +
       +        note@domain.tld |/usr/local/bin/scribo -b /var/gopher -o index.gph
       +
       +Only process email sent from a specific address:
       +
       +        scribo -a author@domain.tld
       +
       +Pipe the body of your messages through a command before writing them:
       +
       +        scribo -x "fmt -s -w 72"
       +
       +License
       +-------
       +ISC License. See LICENSE file for copyright and license details.