Updated README.

This commit is contained in:
lukeroge 2011-11-21 12:32:16 +13:00
parent 6d393a8180
commit 6c04fc80dc
1 changed files with 6 additions and 8 deletions

View File

@ -1,22 +1,20 @@
CloudBot/DEV
---------------------------------------
##CloudBot/DEV
#### About
### About
CloudBot is very heavily based on Skybot by rmmh. (https://github.com/rmmh/skybot)
#### Install
### 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
```
If you use another OS or distro you can find source packages on the module web sites, or try to find the modules packages in your package manager.
Once installing these packages run the bot once with the following command to generate the config file. Stop the bot, edit the config, and run the bot again to start it up.
```python bot.py
```
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
### Requirements
CloudBot runs on Python 2.7. Many of the plugins require lxml and BeautifulSoup. It is developed on Ubuntu 11.10 with Python 2.7.2.