Morten Brix Pedersen 24 лет назад
Родитель
Сommit
b00f64c033
2 измененных файлов с 22 добавлено и 17 удалено
  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
 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:
 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
 The commandline version has the disadvantage that you can only set up one
 channel to be run.
 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
 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
@@ -59,6 +46,23 @@ The syntax and options is explained when doing:
 Setting settings on commandline, will override the relevant settings in
 Setting settings on commandline, will override the relevant settings in
 pisg.cfg.
 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
 CONTACT INFORMATION
 -------------------
 -------------------
 If you have any problems with setting up or running pisg, you should send an
 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>)
      Hanno Hecker <hanno-pisg@bee.de>)
    * A problem with multiple mode changes (+vv, +oo) in Trillian format has
    * A problem with multiple mode changes (+vv, +oo) in Trillian format has
      been fixed.
      been fixed.
+   * README has been polished/modified
    * Changes thanks to Matthew "Cheetah" Gabeler-Lee (<msg2@po.cwru.edu>):
    * Changes thanks to Matthew "Cheetah" Gabeler-Lee (<msg2@po.cwru.edu>):
     * A ShowWordTime option now exists that works the same as ShowLineTime,
     * A ShowWordTime option now exists that works the same as ShowLineTime,
       but uses word stats
       but uses word stats