Read Me

 _  __      _        _       ____        _   
| |/ /_ __ (_)_ __  (_) __ _| __ )  ___ | |_ 
| ' /| '_ \| | '_ \ | |/ _` |  _ \ / _ \| __|
| . \| | | | | | | || | (_| | |_) | (_) | |_ 
|_|\_\_| |_|_|_| |_|/ |\__,_|____/ \___/ \__|
                  |__/  Version 1.1          

Welcome to KninjaBot, version 1.1!

Thanks for choosing the KninjaBot IRC robot! KninjaBot is a highly
modular and extensible robot, and can be custom configured to your liking.

__--Quick Set Up Guide--__

Prerequisites:
   1) A computer (preferably one that's working).
   2) An internet connection (this should be working too).
   3) At least one IRC channel to put this robot on.
   4) Python 2.3 or later.

Steps (Unix/Linux/Mac OS X):
   1) Open a terminal emulator (Terminal.app, gnome-terminal, xterm, etc)
   2) 'cd' to the Kninja directory (ex. cd /home/user/kninja/)
   3a) Run ./Config.sh and follow the directions. (Goto step 4)
         ---OR---
       Edit ./files/kninja.conf.example and then mv ./files/
                             kninja.conf.example kninja.conf
         Remember that if you do this, you must also do step 3b.
   3b) Run 'python configure.py -P add -u <user>:<password>:10'
          Remember that the user is the nick that you will be logging
          on from.
   4) Now run ./kninja start
   5) ????
   6) PROFIT!

Steps (Windows):
   1) Open 'cmd.exe' or, if you're running a decrepit OS like
                                Windows 98, 'command.com'
   2) 'cd' to the Kninja directory (ex. cd C:\Documents and Settings\
                                    User\Kninja\)
   3) Run 'python configure.py -a <server> -c <channels> -n <nick>'
             * For more options, run 'python configure.py'
   4) Run 'python configure.py -P add -u <user>:<password>:10'
          Remember that the user is the nick that you will be logging
          on from.
   5) Run 'python kninja.py'

Congratulations! You have successfully set up KninjaBot. Enjoy!

Feel free to report bugs, comments, or feature requests to kman at: kman@kman.me.uk.

Thanks for choosing KninjaBot!