#Introduction

Willie is a simple, lightweight, open source, easy-to-use IRC Utility bot, written in Python. It's designed to be easy to use, run and extend.

#Installation

The easiest way is to simply run ``setup.py install``. Willie can also be run
by copying ``scripts/willie`` to ``willie.py`` in the root of the source
directory (i.e, the one with the ``scripts`` folder in it), and running that.

#Making your own modules:

To make your own module for Willie, please consult the documentation at http://willie.dftba.net  
To get a copy of the documentation locally, run
```
cd doc
make html
```

If you installed Willie (with ``setup.py`` or through your distro's package
manager), the easiest place to put the module is in ``~/.willie/modules``, and
then add a line to the ``[core]`` section of your config file saying 
``extra = /home/yourname/.willie/modules``. If you're running straight from the
source directory, you can just put it in the ``willie/modules`` subdirectory.

#Command list and various user documentation:

See wiki at https://github.com/embolalia/willie/wiki

#Questions?

Contact us on irc.dftba.net channel #tech

For a list of contributions to the Jenni fork see the file ``CREDITS``.