Nice new README for pisg.cfg format, you are welcome to find bugs in it :)

CONFIG-README

@@ -1,6 +1,67 @@
-NOT DONE YET
+README for pisg.cfg - the configuration file for pisg
+------------------
+This file is used for two things:
+ - Setting user options (for user aliases, pics, ignores and links)
+ - Setting pisg config options (for general things with pisg)
+ - Word options (for adding words that are meant to be 'foul(bad) language')
+ 
+
+USER OPTIONS
+------------------
+User options are set with a simple SGML like syntax; remember the nick is
+always required.
+
+For example to add aliases to a nick, then you could do this:
+    <user nick="Joe" alias="Joe^*">
+
+This will add alle Joe^'s to 'Joe' in the stats.
+
+Another thing you can do is to add a picture to a user:
+    <user nick="Ben" pic="ben_holiday.jpg">
+
+Also you can add links to URLs and e-mails:
+    <user nick="Christine" link="http://www.christine.com>
+
+    or
+
+    <user nic="Chris" link="chris@host.com">
+
+The last thing you can do is to ignore nicks (for example bots):
+    <user nick="nameofbot" ignore="y">
+
+You don't have to do all this in many lines, you could just as easily do:
+<user nick="Joe" alias="Joe^away Joe^work" pic="joe.jpg" link="joe@joe.com">
+
+(Here the aliases is a space seperated list of nicks, that also works! But *
+as a wildcard is smarter, but also slower).
+
+
+PISG OPTIONS
+------------------
+This is a tougher part, a lot of things can be set here, simply the syntax
+is like this:
+
+<set variable="value">
+
+For example:
+<set channel="#channel">
+
+You can also combine settings into one line such as:
+<set channel="#channel" logfile="/var/log/channel.log">
+
+A normal complete line for a channel would be:
+<set channel="#channel" logfile="channel2.log" format="mIRC" network="SomeIRCNet" outputfile="index.html">
+
+Other examples:
+<set lang='EN' langfile='lang.txt'>
+<set bgcolor="#dedeee" text="black" hbgcolor="#666699" hcolor="white" hicell="#BABADD" hicell2="#CCCCCC">
+<set activenicks="25" activenicks2="30" topichistory="3" nicktracking="0" timeoffset="+0">
+
+
+There is many variables which can be set, here's a list of them all:
+
+ * The most useful ones *
 
-The variables are:
 channel                The name of your channel.
 logfile                The exact filename of the logfile
 format                 logfile format. see FORMATS file
@@ -26,7 +87,7 @@ lang                   Language to use:
 
 langfile               Name of language file
 
-# Here you can set the colors for your stats page..
+  * Colors for your stats page *
 
 bgcolor                Background color of the page
 text                   Normal text color
@@ -44,7 +105,7 @@ rankc                  Colors of 'ranks' (1,2,3,4)
 pic1                   Bar-graphic-file for normal times
 pic2                   Bar-graphic-file for top-times
 
-# Other things that you might set, but not everyone cares about them
+  * Small things, useful for some people *
 
 minquote               Minimal value of letters for a random quote
 maxquote               Maximum value of letters for a random quote
@@ -61,3 +122,20 @@ timeoffset             A time offset on the stats page - if your
                        machine where the stats are being
                        generated, then for example do +1
 
+
+WORD OPTIONS
+------------------
+pisg has the feature of making stats of people using "foul words" or bad
+language, like fuck, shit, etc. but this is something people would like to
+configure to their own language and slang.
+
+So this option configures which words which are considered to be "foul":
+
+<words foul="ass bitch fuck">
+
+Or in German:
+<words foul="scheisse scheiße kacke">
+
+
+
+Have fun configuring pisg! :)