From d9e4cef025b02d890b0c4ee01734d55dcbcb5ffb Mon Sep 17 00:00:00 2001 From: Jeremy Fincher Date: Sun, 4 Jan 2004 15:16:50 +0000 Subject: [PATCH] Initial checkin. --- docs/GETTING_STARTED | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/GETTING_STARTED diff --git a/docs/GETTING_STARTED b/docs/GETTING_STARTED new file mode 100644 index 000000000..1a8c1a7eb --- /dev/null +++ b/docs/GETTING_STARTED @@ -0,0 +1,24 @@ +Ok, so you've decided to try out Supybot. That's great! The more people who +use Supybot, the more people can submit bugs and help us to make it the best +IRC bot in the world :) + +So what do you do? First thing you'll want to do is run (with root +privileges) "python setup.py install". This will install Supybot globally. +### TODO: Local installs. +### TODO: Explain how to run tests? + +After that, you'll want to run supybot-wizard and generate yourself a +configuration file. To run this configuration file, you'll want to type +"supybot ", replacing with the name of the +configuration file you just generated with the supybot-wizard. The supybot +program accepts several command-line parameters which you can see by simply +running "supybot --help" + +After that, you should have a bot up and running in the + +# TODO: Identification, owner, etc. + +# Common problems +# import error in http (relies on python-xml) +# import error in database-based plugins. +# Can't find the wizard. Full path on Windows and MacOS X.