A README file is needed

[Jamu Kakar]

The lack of documentation makes using Mup hard. I'm currently having
troubles getting it running, for example.

[Jamu Kakar (jkakar)]

For example, there's no easy way to determine what the configuration
file should look like.

[Gustavo Niemeyer (niemeyer)]

There's a third generation mup coming along, so this will be solved at the same time (let's keep this bug open meanwhile, to track this need).

The second generation attempt is based on supybot, but it has a constant leak somewhere in the framework of supybot itself, which is why I'm going to drop the idea of using it (the goal of using a pre-existing framework was precisely to avoid having to do that sort of debugging).

The current plan is to have a framework which enables completely independent plugins to be developed, as separate processes, so that people can hack things in whatever shape and language they want to, without affecting the core of the system.

I'm still working on some of the foundations to get that in place, so stay tunned (or get in touch if you want to speed it up :-).