dunno

[infobot.git] / README

diff --git a/README b/README
index 7d080ffa9a95da378b349f3c475d41c092aa2dc9..4629cda7a63184c3a0e6553c7d84bae39b38590d 100644 (file)
--- a/README
+++ b/README
@@ -1,37 +1,39 @@
-blootbot v1.0.0 (20000729)
--------------------------
+# $Id$
+
+                                 -------------
+                                 -- Infobot --
+                                 -------------

 
 INTRODUCTION
 
 INTRODUCTION

-       This bot is based upon infobot-0.44.2 by kevin lenzo
-<lenzo@cs.cmu.edu>. The basis of infobot is still there but _many_ wild
-features have been added. Along the way, a couple of typos were spotted
-in the original infobot source and fixed in this version. Without infobot,
-there would be no blootbot so all thanks to kevin for bringing infobot in
-the first place.
+       This bot is based upon blootbot, which was a fork of infobot-0.44.2 by
+Kevin Lenzo <lenzo@cs.cmu.edu>, which is now officially rebranded back to
+infobot!  The basis of infobot is still there but _many_ wild features have
+been added.  Along the way, many issues were spotted in the original
+infobot source and fixed in this version. Many new bugs have been added as well.
+Thanks to kevin for bringing infobot in the first place.
+

 
 FEATURES
        * Additional information stored with factoids. (factinfo)
 
 FEATURES
        * Additional information stored with factoids. (factinfo)

-       * Wide range of statistics for Bot, Factoids, IRC, Debian.
+       * Wide range of statistics for Bot, Factoids, IRC, Debian

          (status, factstats, ircstats, chanstats, cmdstats)
          (status, factstats, ircstats, chanstats, cmdstats)

-       * Advanced topic management. (the first cool feature)
-       * Improved factoid search, allowing search by key or value.
+       * Advanced topic management
+       * Improved factoid search, allowing search by key or value

        * Freshmeat support (freshmeat.net)
        * Freshmeat support (freshmeat.net)

-       * Debian Contents and Packages, search and info.
-       * ChanServ/NickServ (OPN) support.
-       * WWW-Search (eg: google for BLAH)
-       * Slashdot, Kernel and Freshmeat auto-update announcements.
-       * Units conversion (provided by external module, Units-Module)
-
-       DESIGN
-               - Modularity. Ability to disable IRC or Factoid support.
-               - Funky pseudo Module autoloader support
-               - Eleet Forker() function
-
-Improvements include:
-       * log file is not opened and closed for each line of data
-               => unblocked logging is used.
-       * seen data is not flushed for each public message on IRC
-               => caching and flushing over an interval is used.
+       * Debian Contents and Packages, search and info
+       * ChanServ/NickServ (freenode) support
+       * WWW-Search (eg: google for BLAH) (NOTE: Currently broken)
+       * Slashdot, Kernel, RSS and Freshmeat auto-update announcements
+       * Units conversion (provided by external "units" program)
+
+
+DESIGN
+       - Modularity. Ability to disable IRC or Factoid support
+       - Funky pseudo Module autoloader support
+       - Modules called via Forker() to avoid blocking
+    - Non blocking logs
+    - Seen data periodicaly flushed for efficiency
+

 
 HISTORY
        As of 0.99pre1, blootbot supports mysql database in the hope to
 
 HISTORY
        As of 0.99pre1, blootbot supports mysql database in the hope to


@@ -49,9 +51,13 @@ back. It should work in all but 3 specific (countdown, factstats unreq)
 cases. preliminary pgsql support has been added but someone with pgperl
 knowledge needs to fix it up or at least unify the module with mysql.
 
 cases. preliminary pgsql support has been added but someone with pgperl
 knowledge needs to fix it up or at least unify the module with mysql.
 

+       As of 1.5.0, blootbot was rebranded back to infobot.
+
+

 INSTALLATION
   - Read the included INSTALL file
 
 INSTALLATION
   - Read the included INSTALL file
 

+

 NOTICE
        Be warned that this bot consumes quite a lot of memory upon start
 up and during usage. Right now, 7.4megs is used for old'ish perl, 8.3megs
 NOTICE
        Be warned that this bot consumes quite a lot of memory upon start
 up and during usage. Right now, 7.4megs is used for old'ish perl, 8.3megs


@@ -66,9 +72,6 @@ However, these people do not realize the potential of open wingates.
 test all modifications properly (and extensively).  Suggestions are
 welcomed.
 
 test all modifications properly (and extensively).  Suggestions are
 welcomed.
 

-       gp@OPN is currently working on a C version of infobot or
-blootbot, not based on the above source base.  Core factoid code and
-mysql support works - but that is it.

 
 MODIFICATIONS
        All modifications are that of the blootbot author unless otherwise
 
 MODIFICATIONS
        All modifications are that of the blootbot author unless otherwise


@@ -112,12 +115,13 @@ NOTES
 through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
 '.' otherwise it is sent to the bot chat net
 
 through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
 '.' otherwise it is sent to the bot chat net
 

-### UNTESTED:
-       - user statistics shown by 'seen'. bug in this?
+
+UNTESTED:
+       - user statistics shown by 'seen'.

        - User Information Services.
        - new wingate caching/file-read code.
        - disabling IRC/factoid support code.
        - User Information Services.
        - new wingate caching/file-read code.
        - disabling IRC/factoid support code.

-       - PG supports need to be worked and thoroughly tested.
+       - PGSql support needs to be more thoroughly tested.

 
 
 CONTRIBUTIONS
 
 
 CONTRIBUTIONS


@@ -126,16 +130,27 @@ modifications, aswell as giving suggestions and ideas in the early
 development stages. Bashing of modifications courtesy of larne, irq, lilo
 and \broken.
 
 development stages. Bashing of modifications courtesy of larne, irq, lilo
 and \broken.
 

-       mu@OPN for the SAR (=~ s///) and Topic history patch.
+       mu@freenode for the SAR (=~ s///) and Topic history patch.

 
        someone emailed me a patch to fix up telnet but I accidently
 deleted the message together with the patch after replying to the guy. I
 hope to get that same guy to re-send me the patch...
 
 
        someone emailed me a patch to fix up telnet but I accidently
 deleted the message together with the patch after replying to the guy. I
 hope to get that same guy to re-send me the patch...
 

-       MbM@OPN sent a patch to clean up behaviour of factoids
+       MbM@freenode sent a patch to clean up behaviour of factoids

 (adding, removing, modifying).  Thanks.
 
 
 CONTACT
        Contributions of a patch, or anything, can be sent to
 (adding, removing, modifying).  Thanks.
 
 
 CONTACT
        Contributions of a patch, or anything, can be sent to

-<dms@users.sourceforge.net>
+<infobot-devel@lists.sourceforge.net>
+
+Some Documentation is on the website. Please see it for details or
+visit: http://infobot.sourceforge.net/
+
+
+IRC
+       If your looking to hang out on IRC, feel free. We can be found
+in the #infobot channel on irc.freenode.net. See you there!
+
+
+# vim:ts=4:sw=4:expandtab:tw=80