]> git.donarmstrong.com Git - infobot.git/blobdiff - README
changed email address
[infobot.git] / README
diff --git a/README b/README
index 709d64cf831c9bf3de1e7c2465a0b6edf37da999..24817b780dc161fa54ef42b7ef73ed3f464c8228 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-blootbot v1.0.0RC3 (20000709)
+blootbot v1.0.0 (20000729)
 -------------------------
 
 INTRODUCTION
@@ -9,28 +9,54 @@ 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.
 
-       as of 0.99pre1, blootbot supports mysql database in the hope to
+FEATURES
+       * Additional information stored with factoids. (factinfo)
+       * Wide range of statistics for Bot, Factoids, IRC, Debian.
+         (status, factstats, ircstats, chanstats, cmdstats)
+       * Advanced topic management. (the first cool feature)
+       * Improved factoid search, allowing search by key or value.
+       * 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.
+
+HISTORY
+       As of 0.99pre1, blootbot supports mysql database in the hope to
 increase performance and to avoid borked over dbm's which occurred when
 the bot crashed (??). The mysql code is far larger (or perhaps twice
 as many functions) than expected even though a few functions were needed
 for DBM due to lack of table deficiencies.
 
-       as of 1.0.0pre1, blootbot takes advantage of Net::IRC. The change
-over was fairly comfortable (95% clean). Just minor problems here and
-there, mostly debugging and getting it right.
+       As of 1.0.0pre1, blootbot takes advantage of Net::IRC. The
+change over was fairly comfortable (95% clean). Just minor problems here
+and there, mostly debugging and getting it right.
 
-UPDATE:
-       as of 1.0.0RC2, the old style DBM (Berkeley) has been ported 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.
+       As of 1.0.0RC2, the old style DBM (Berkeley) has been ported
+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.
+
+INSTALLATION
+  - Read INSTALL and INSTALL.patches
+  - Copy files/sample.config to files/infobot.config
+  - Edit files/infobot.config
+  - ./blootbot
 
-       Please apply the patches from patches/*.patch. Method:
-               cd /usr/lib/perl5
-               cat *.patch | patch -p0
-               ### FIXME: what's the best way to apply patches?
-               ### for the time being, patch manually.
 
+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
 with perl 5.005. fork() is used but don't be alarmed at the memory usage
@@ -48,30 +74,6 @@ welcomed.
 to support dbm185or2//mysql//postgresql. It's available at
 ftp://leguin.org.uk/pub/bloatbot/
 
-FEATURES
-       * Additional information stored with factoids. (factinfo)
-       * Wide range of statistics for Bot, Factoids, IRC, Debian.
-         (status, factstats, ircstats, chanstats, cmdstats)
-       * Advanced topic management. (the first cool feature)
-       * Improved factoid search, allowing search by key or value.
-       * 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.
-
 MODIFICATIONS
        All modifications are that of the blootbot author unless otherwise
 specified, like none.  See 'ChangeLog' for details.  A list of future
@@ -109,10 +111,6 @@ variables.  If you're hardcore, check out 'CommandStubs.pl' and
        unset <param>           -- ...
 
 
-INSTALLATION
-       edit files/infobot.config and modify according to needs.
-
-
 NOTES
        To administrate/control the bot remotely, this can only be done
 through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
@@ -126,7 +124,6 @@ through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
        - PG/DBM supports need to be worked and thoroughly tested.
 
 
-
 CONTRIBUTIONS
        jCommons, is, netgod, mu and Mercury for attempting to break my
 modifications, aswell as giving suggestions and ideas in the early
@@ -145,4 +142,4 @@ hope to get that same guy to re-send me the patch...
 
 CONTACT
        Contributions of a patch or a job offer can be sent to
-<xk@leguin.openprojects.net>
+<dms@users.sourceforge.net> [DOES IT WORK??]