Morten Brix Pedersen 24 anni fa
parent
commit
b00f64c033
2 ha cambiato i file con 22 aggiunte e 17 eliminazioni
  1. 21 17
      README
  2. 1 0
      docs/Changelog

+ 21 - 17
README

@@ -9,8 +9,10 @@ this distribution in the 'docs' directory.
 
 SETTING UP PISG
 ---------------
-Full documentation located in docs/pisg-doc.txt or docs/html/index.html for
-a HTML version. Quick explanation below:
+Full documentation for pisg is located in 'docs/pisg-doc.txt' and
+'docs/html/index.html' for a HTML version.
+
+Quick usage instructions below:
 
 It's quite simple to set up pisg. You have 2 choices:
 
@@ -23,21 +25,6 @@ where you can insert your own data.
 The commandline version has the disadvantage that you can only set up one
 channel to be run.
 
-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
-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.
-
-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,
-you should put these in the same directory as your stats file(s) or use the
-'pic_loc' configuration variable.
-
 RUNNING PISG
 ------------
 If you have setup everything inside the config file, then you just need to
@@ -59,6 +46,23 @@ The syntax and options is explained when doing:
 Setting settings on commandline, will override the relevant settings in
 pisg.cfg.
 
+NOTES
+-----
+There is some graphics in the gfx/ folder which pisg uses, you should put
+these in the same directory as your stats file(s) or use the 'PicLocation'
+configuration option.
+
+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.
+
+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.
+The language can be changed from within the pisg.cfg file.
+
+If you have any corrections to the language file, or you want to add a new
+translation, then send it to the mailing list.
+
 CONTACT INFORMATION
 -------------------
 If you have any problems with setting up or running pisg, you should send an

+ 1 - 0
docs/Changelog

@@ -15,6 +15,7 @@ pisg (x.xx)
      Hanno Hecker <hanno-pisg@bee.de>)
    * A problem with multiple mode changes (+vv, +oo) in Trillian format has
      been fixed.
+   * README has been polished/modified
    * Changes thanks to Matthew "Cheetah" Gabeler-Lee (<msg2@po.cwru.edu>):
     * A ShowWordTime option now exists that works the same as ShowLineTime,
       but uses word stats