فهرست منبع

Minor updates to documentation

Morten Brix Pedersen 25 سال پیش
والد
کامیت
dfb20fd8ad
2فایلهای تغییر یافته به همراه17 افزوده شده و 15 حذف شده
  1. 8 13
      README
  2. 9 2
      docs/FORMATS

+ 8 - 13
README

@@ -7,11 +7,6 @@ show for the users of your channel.
 The supported logfile formats is explained in the FORMATS file included with
 The supported logfile formats is explained in the FORMATS file included with
 this distribution in the 'docs' directory.
 this distribution in the 'docs' directory.
 
 
-If you don't have access to any of the clients/bots or you use some other
-IRC client/bot which isn't supported, then it's fairly easy to add support
-for a new IRC log format. Take a look at the source code or send me an
-e-mail with the logfile format.
-
 SETTING UP PISG
 SETTING UP PISG
 ---------------
 ---------------
 It's quite simple to set up pisg. You have 2 choices:
 It's quite simple to set up pisg. You have 2 choices:
@@ -26,25 +21,25 @@ You cannot set up everything on the commandline, only the important things.
 
 
 The 'pisg.cfg' file controls a lot of things, you should read CONFIG-README.
 The 'pisg.cfg' file controls a lot of things, you should read CONFIG-README.
 
 
-NOTE: The stats will look best with a logfile which is at least one day long.
-Some stats (like smilies, exclamation marks etc) doesn't get counted before
-a special amount of time.
+NOTE: The stats will look best with a logfile which is at least one day
+long.  Some stats (like smilies, exclamation marks, etc) doesn't get counted
+before a special amount of time.
 
 
 Also, pisg supports multiple languages so the texts on the stats page will
 Also, pisg supports multiple languages so the texts on the stats page will
 be in your own language; look in lang.txt to see the supported languages.
 be in your own language; look in lang.txt to see the supported languages.
 The language can be changed from within the pisg.cfg file.
 The language can be changed from within the pisg.cfg file.
 
 
-You're welcome to translate pisg to your own language, it's not very hard,
-look in the lang.txt file! If you have any corrections to the language
-file, then please send a patch.
+If you have any corrections to the language file, or you want to add a new
+translation, then send it to the mailing list.
 
 
 And a last note: there is some graphics in the gfx/ folder which pisg uses,
 And a last note: there is some graphics in the gfx/ folder which pisg uses,
-you should put these in the same directory as your stats file(s).
+you should put these in the same directory as your stats file(s) or use the
+'pic_loc' configuration variable.
 
 
 RUNNING PISG
 RUNNING PISG
 ------------
 ------------
 If you have setup everything inside the config file, then you just need to
 If you have setup everything inside the config file, then you just need to
-run it. If you're on a Linux/Unix system, this should do the work:
+run it. If you're on a Linux/BSD/Unix system, this should do the work:
 
 
     $ ./pisg.pl
     $ ./pisg.pl
 
 

+ 9 - 2
docs/FORMATS

@@ -1,8 +1,15 @@
 FORMATS - supported logfile formats by pisg
 FORMATS - supported logfile formats by pisg
 ------------------
 ------------------
 
 
-This file contains a list of the different formats that pisg supports. It
-also includes a sample line for these formats.
+This file contains a list of the different logfile formats which pisg
+supports. It also includes a sample line for these formats.
+
+If you don't have access to any of the clients/bots or you use some other
+IRC client/bot which isn't supported, then it's fairly easy to add support
+for a new IRC log format if you have some Perl knowledge, take a look at
+modules/Pisg/Parser/Format/Template.pm. If you don't have any Perl
+knowledge, then mail a sample logfile to the mailinglist (preferred as a
+link to the logfile)
 
 
 * mIRC:
 * mIRC:
   - A client for Windows (www.mirc.com)
   - A client for Windows (www.mirc.com)