Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorRichard Darst <rkd@zgib.net>2009-06-16 02:22:14 (GMT)
committer Richard Darst <rkd@zgib.net>2009-06-16 02:22:14 (GMT)
commitd1448d12a810f46a52fb96651070bb12f4c14104 (patch)
tree214046dd2107dec07319de43222890bb5f53e0f3 /README.txt
parent45e106a7306ec7df2f4374ec3f9d9624223e1304 (diff)
add "design decisions" section to the readme
darcs-hash:20090616022214-82ea9-f8e7375b16ca0cfc1cb40107c181cd7405fc4771.gz
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.txt b/README.txt
index c241f01..6588a94 100644
--- a/README.txt
+++ b/README.txt
@@ -11,6 +11,25 @@ information on configuring supybot the first time, including taking
ownership the first time.
+DESIGN DECISIONS
+~~~~~~~~~~~~~~~~
+The MeetBot plugin doesn't operate like a regular supybot plugin. It
+bypasses the normal command system. Instead it listens for all lines
+(it has to log them all anyway) and if it sees a command, it acts on it.
+
+- Separation of meeting code and plugin code. This should make it
+ easy to port to other bots, and perhaps more importantly make it
+ easier to maintain, or rearrange, the structure within supybot.
+
+- Not making users have to register and have capabilities added. The
+ original meetbot ran as a service to many channels not necessarily
+ connected to the original owner.
+
+- Makes it easier to replay stored logs. I don't have to duplicate the
+ supybot command parsing logic, such as detecting the bot nick and
+ running the proper command. Also, there might be command overlaps
+ with some preexisting plugins.
+
INSTALLATION
~~~~~~~~~~~~