CloudBot/README.md

##CloudBot/DEV

### About
CloudBot is very heavily based on Skybot by rmmh. (https://github.com/rmmh/skybot)

### Install
Before you can run the bot, you need to install a few Python modules. These are *LXML* and *BeautifulSoup*.  On Ubuntu these can be installed using the following commands:

```sudo apt-get install python-lxml
```

```sudo apt-get install python-beautifulsoup
```

For the spell.py plugin to work you need *Enchant*. This can be installed with:
```sudo apt-get install python-enchant
```

The whois.py plugin will work by default, but *not very well*. To make it work properly you will need to install the native *whois* package. This can be installed with:
```sudo apt-get install whois
```

If you use another OS or distro you can find source packages on the module(s) web site, or you can try to find suitable packages in your package manager.

Once installing these packages run the bot once with ```python bot.py``` to generate the config file. Stop the bot, edit the config, and run the bot again with ```python bot.py``` to start it up :)

### Requirements
CloudBot runs on Python 2.7. Many of the plugins require lxml and BeautifulSoup. It is devloped on Ubuntu 11.10 with Python 2.7.2.

### License
CloudBot is licenced under the GPL v3 license. The terms are as follows.


``` 
    CloudBot DEV

    Copyright © 2011 Luke Rogers. <http://www.dempltr.com/> <lukeroge@gmail.com>

    CloudBot is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    CloudBot is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with CloudBot.  If not, see <http://www.gnu.org/licenses/>.
```