From 6c04fc80dcdd719c86c0747eb3c4d35f68deb479 Mon Sep 17 00:00:00 2001 From: lukeroge Date: Mon, 21 Nov 2011 12:32:16 +1300 Subject: [PATCH] Updated README. --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1dc9d15..fb0f02e 100644 --- a/README.md +++ b/README.md @@ -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.