Updated README
This commit is contained in:
parent
28503b4367
commit
0d8317eef7
|
@ -0,0 +1,22 @@
|
|||
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
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
#### 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.
|
|
@ -1,17 +0,0 @@
|
|||
= CloudBot - A fork of SkyBot =
|
||||
|
||||
==Goals==
|
||||
* simplicity
|
||||
** little boilerplate
|
||||
** minimal magic
|
||||
* power
|
||||
** multithreading
|
||||
** automatic reloading
|
||||
** extensibility
|
||||
|
||||
==Features==
|
||||
* Multithreaded dispatch and the ability to connect to multiple networks at a time.
|
||||
* Easy plugin development with automatic reloading and a simple hooking API.
|
||||
|
||||
==Requirements==
|
||||
CloudBot runs on Python 2.7. Many of the plugins require [[http://codespeak.net/lxml/|lxml]] and [[http://www.crummy.com/software/BeautifulSoup/|BeautifulSoup]]. It is developed on Ubuntu 11.10 with Python 2.7.2.
|
Reference in New Issue