tRemove README parts about writing the gopher index - 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 7a95d651ef1c093906203e2167c7c9e60ddf3e11
(DIR) parent fa6e4d8d02cd3954691962240e153e5025a5ebb3
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Sun, 20 Sep 2020 00:05:49 +0200
Remove README parts about writing the gopher index
Diffstat:
M README | 17 +++++++----------
1 file changed, 7 insertions(+), 10 deletions(-)
---
(DIR) diff --git a/README b/README
t@@ -2,18 +2,15 @@ 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 !
+Publish gopher notes just by sending 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.
+aliases(5), or forward(5) file. The emails are then passed to the
+program on STDIN, which will in turn write the log entry to the specified
+directory.
-The log entries are written in a file derived from the "Subject" and
-timestamped at end of file, based on the "Date" header.
+The filename is derived from the "Subject" header, and timestamped at
+end of file, based on the "Date" header.
Installation
------------
t@@ -29,7 +26,7 @@ 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
+ note@domain.tld |/usr/local/bin/scribo -b /var/gopher
Only process email sent from a specific address: