Add decoding and parsing of From: etc.

[usenet/newsstats.git] / doc / INSTALL

diff --git a/doc/INSTALL b/doc/INSTALL
index 225fdbf..a5ca01d 100644 (file)
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -1,7 +1,7 @@
-NewsStats 0.1  (c) 2010 Thomas Hochstein <thh@inter.net>
+NewsStats 0.1  (c) 2010-2013 Thomas Hochstein <thh@inter.net>
 
-NewsStats is a software package for gathering statistical data live
-from a Usenet feed and subsequent examination.
+NewsStats is a software package used to gather statistical information
+from a live Usenet feed and for its subsequent examination.
 
 This script package is free software; you can redistribute it and/or
 modify it under the terms of the GNU Public License as published by
@@ -13,6 +13,8 @@ INSTALLATION INSTRUCTIONS
 
 1) Install the scripts
 
+   * Get INN, mysql, Perl, and the necessary modules installed (see README).
+
    * Download the current version of NewsStats from
      <http://th-h.de/download/scripts.php>.
 
@@ -20,7 +22,8 @@ INSTALLATION INSTRUCTIONS
 
      # tar -xzf newsstats-nn.tar.gz
 
-     Scripts in this path should be executable by the news user.
+     Scripts in this path - at least feedlog.pl - should be executable by the
+     news user.
 
 2) Configuration
 
@@ -80,8 +83,8 @@ INSTALLATION INSTRUCTIONS
    * Edit your 'newsfeeds' file and insert something like
 
      ## gather statistics for NewsStats
-     newsstats!
-             :!*,de.*
+     newsstats!\
+             :!*,de.*\
              :Tc,WmtfbsPNH,Ac:/path/to/feedlog.pl
 
    * You should only feed that hierarchy (those hierarchies ...) to
@@ -109,7 +112,7 @@ INSTALLATION INSTRUCTIONS
    Everything should be going smoothly now.
 
    * If INN is spewing error messages to 'errlog' or reporting
-     continous respaws of feedlog.pl to 'news.notice', stop your feed:
+     continous respawns of feedlog.pl to 'news.notice', stop your feed:
 
      # ctlinnd drop 'newsstats!'