README.txt - update for restructuring
Ignore-this: f574285d71ff63ab7f5075a7f2ccc466 darcs-hash:20101207221652-82ea9-503b0446dd8e4bb131da9ec2feb0603f3882881a.gz
This commit is contained in:
Richard Darst
parent
7c094f8ef8
commit
64e0be8341
126
README.txt
126
README.txt
@ -1,4 +1,4 @@
|
||||
USAGE
|
||||
ABOUT
|
||||
~~~~~
|
||||
http://wiki.debian.org/MeetBot
|
||||
|
||||
@ -6,9 +6,82 @@ Inspired by the original MeetBot, by Holger Levsen, which was itself a
|
||||
derivative of Mootbot (https://wiki.ubuntu.com/ScribesTeam/MootBot),
|
||||
by the Ubuntu Scribes team.
|
||||
|
||||
/usr/share/doc/supybot/GETTING_STARTED.gz (on Debian systems) provides
|
||||
information on configuring supybot the first time, including taking
|
||||
ownership the first time.
|
||||
The Supybot file GETTING_STARTED
|
||||
(/usr/share/doc/supybot/GETTING_STARTED.gz on Debian systems) provides
|
||||
hinformation on configuring supybot the first time, including taking
|
||||
ownership the first time. You really need to read this if you haven't
|
||||
used supybot before.
|
||||
|
||||
|
||||
|
||||
INSTALLATION
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Requirements
|
||||
------------
|
||||
* pygments (optional) (debian package python-pygments) (for pretty IRC
|
||||
logs). This package is no longer required (after HTMLlog2 became
|
||||
default)
|
||||
|
||||
|
||||
Install Supybot
|
||||
---------------
|
||||
* You need to install supybot yourself. You can use supybot-wizard to
|
||||
make a bot configuration.
|
||||
|
||||
* See the file GETTING_STARTED
|
||||
(/usr/share/doc/supybot/GETTING_STARTED.gz on a Debian system).
|
||||
This tells all about supybot installation, and is an important
|
||||
prerequisite to understanding MeetBot configuration.
|
||||
|
||||
* Don't use a prefix character. (disable this:
|
||||
supybot.reply.whenAddressedBy.chars:
|
||||
in the config file - leave it blank afterwards.) If you do use a
|
||||
prefix character, it should be different than the "#" MeetBot
|
||||
prefix character. There are issues here which still need to be
|
||||
worked out.
|
||||
|
||||
Install the MeetBot plugin
|
||||
--------------------------
|
||||
|
||||
* Move the Meeting directory into your ``plugins`` directory of
|
||||
Supybot.
|
||||
|
||||
* You need the ``ircmeeting`` directory to be importable as a python
|
||||
module.
|
||||
|
||||
* Easy method: Copy ``ircmeeting`` into the ``Meeting`` directory.
|
||||
This makes ``ircmeeting`` work as a relative import. However,
|
||||
this will probably stop working with some future Python version.
|
||||
|
||||
* Other method: Copy ``ircmeeting`` somewhere into $PYTHONPATH.
|
||||
|
||||
* Make sure the plugin is loaded. Use the command ``load Meeting``.
|
||||
You can check the command ``config plugins`` to check what is
|
||||
loaded.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
* Make supybot join any channels you are interested in. The wizard
|
||||
handles this the first time around. After that, I guess you have to
|
||||
learn about supybot. If the plugin is loaded, it is active on ALL
|
||||
channels the bot is on. You can also command the bot after it's
|
||||
online.
|
||||
|
||||
* Make a `meetingLocalConfig.py` file and put it somewhere that it can
|
||||
be found:
|
||||
- in $PYTHONPATH
|
||||
- in the ircmeeting/ directory
|
||||
- in the current working directory
|
||||
|
||||
* Configuration of meetingLocalConfig.py is covered in the manual,
|
||||
doc/Manual.txt
|
||||
|
||||
Supybot does a lot, far more than this one readme can talk about. You
|
||||
need to learn about supybot a bit, too, in order to be able to use
|
||||
MeetBot properly.
|
||||
|
||||
|
||||
|
||||
DESIGN DECISIONS
|
||||
@ -31,51 +104,6 @@ bypasses the normal command system. Instead it listens for all lines
|
||||
with some preexisting plugins.
|
||||
|
||||
|
||||
INSTALLATION
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Requirements:
|
||||
* pygments (optional) (debian package python-pygments) (for pretty IRC
|
||||
logs). This package is no longer required (after HTMLlog2 became
|
||||
default)
|
||||
* docutils (optional) (debian package python-docutils) (for
|
||||
restructured text to HTML conversion). This is not used in most
|
||||
installations and no longer recommended.
|
||||
|
||||
* Install supybot. You can use supybot-wizard to make a bot
|
||||
configuration.
|
||||
|
||||
* See the file GETTING_STARTED
|
||||
(/usr/share/doc/supybot/GETTING_STARTED.gz on a Debian system).
|
||||
This tells all about supybot installation, and is an important
|
||||
prerequisite to understanding MeetBot configuration.
|
||||
|
||||
* Don't use a prefix character. (disable this:
|
||||
supybot.reply.whenAddressedBy.chars:
|
||||
in the config file - leave it blank afterwards.) If you do use a
|
||||
prefix character, it should be different than the "#" MeetBot
|
||||
prefix character. There are issues here which still need to be
|
||||
worked out.
|
||||
|
||||
* Move the MeetBot directory into your plugins directory of Supybot.
|
||||
|
||||
* Make supybot join any channels you are interested in. The wizard
|
||||
handles this for the first part. After that, I guess you have to
|
||||
learn about supybot (I don't know enough yet...). If the plugin is
|
||||
loaded, it is active on ALL channels the bot is on. You can also
|
||||
command the bot after it's online.
|
||||
|
||||
* Make sure the plugin is loaded.
|
||||
supybot.plugins: Admin Misc User MeetBot Owner Config Channel
|
||||
(can also control loading after the bot is started)
|
||||
|
||||
Supybot does a lot, but I don't know much about it. Hopefully Supybot
|
||||
expert users can enlighten me as to better ways to do things.
|
||||
|
||||
In particular, supybot has a large configuration system, which I know
|
||||
nothing about. It may be worth hooking MeetBot into that system.
|
||||
|
||||
|
||||
|
||||
LICENSE
|
||||
~~~~~~~
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user