ChCh
/
CloudBot
Archived
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

MOAR READMEH

This commit is contained in:
neersighted 2012-02-28 18:00:12 -08:00
parent 1492b3bba3
commit ec3e36423d
1 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,16 +1,16 @@
##CloudBot/DEV
# `CloudBot`/DEV
### About
CloudBot is very heavily based on [Skybot](http://git.io/skybot) by rmmh.
## About
`CloudBot` is very heavily based on [Skybot](http://git.io/skybot) by rmmh.
CloudBot is meant to be a simple, extendable Python IRC bot, with minimal magic.
`CloudBot` is meant to be a simple, extendable `Python` IRC bot, with minimal magic.
### Download
Get Cloudbot at [git.io/getcloudbot](http://git.io/getcloudbot "CloudBot").
## Download
Get `CloudBot` at [git.io/getcloudbot](http://git.io/getcloudbot "CloudBot").
Unzip, and follow the install directions.
### Install
Before you can run the bot, you need to install a few Python modules. These are `lXML`, `BeautifulSoup`, `MyGengo`, and `HTTPlib2`. These can be installed with PIP (The python packager):
## Install
Before you can run the bot, you need to install a few `Python` modules. These are `lXML`, `BeautifulSoup`, `MyGengo`, and `HTTPlib2`. These can be installed with PIP (The `Python` packager):
`sudo pip install lxml`
@ -20,19 +20,20 @@ Before you can run the bot, you need to install a few Python modules. These are
`sudo pip install httplib2`
On Debian based systems, you can get pip with
On `Debian` based systems, you can get pip with
`sudo apt-get install pip`
For .spell to work, we also need a library called `Enchant`. On Debian based systems, install with
For .spell to work, we also need a library called `Enchant`. On `Debian` based systems, install with
`sudo apt-get install python-enchant`
In addition, for .whois to work optimally, you must have `whois` installed. Again, on Debian based systems, install it with
In addition, for .whois to work optimally, you must have `whois` installed. Again, on `Debian` based systems, install it with
`sudo apt-get install whois`
If you are a user of another Linux disto, use your package manager to install the modules, or use Google to locate source packages you can install.
If you are a user of another Linux disto, use your package manager to install the modules, or use `Google` to locate source packages you can install.
Once you have installed the required dependencies, run the bot with
`python bot.py`
@ -43,30 +44,32 @@ It will generate a default config for you. Once you have editied the config, ru
and it will connect to any server(s) you have added to the config. (Config docs at the [wiki](http://git.io/cloudbotconfig))
### Documentation
## Documentation
To configure your CloudBot, vist the [Config Wiki Page](http://git.io/cloudbotconfig).
To configure your `CloudBot`, vist the [Config Wiki Page](http://git.io/cloudbotconfig).
To write your own plugins, vist the [Plugin Wiki Page](http://git.io/cloudbotplugins).
More at the [Wiki Home Page](http://git.io/cloudbotwiki).
### Requirements
CloudBot runs on Python 2.7.x. It is developed on Debian Wheezy/Testing with Python 2.7.2.
## Example `CloudBot`s
Windows users: Windows compatibilty is broken, but we do intend to add it back. (Eventually)
### Example CloudBots
The developers of CloudBot run two Cloudbots on [Espernet](http://esper.net).
The developers of `CloudBot` run two `CloudBot`s on [Espernet](http://esper.net).
They can both be found in [#CloudBot](irc://irc.esper.net/cloudbot "Connect via IRC to #CloudBot on irc.esper.net).
**mau5bot** is the stable bot, and runs on the lastest release version of CloudBot. (mau5bot is running on Ubuntu Server Oneric Ocelot/11.10 with Python 2.7.2)
**mau5bot** is the stable bot, and runs on the lastest release version of `CloudBot`. (mau5bot is running on `Ubuntu Server` Oneric Ocelot/11.10 with `Python` 2.7.2)
**neerbot** is the unstable bot, and runs on the lastest development version of CloudBot. (neerbot is running on Debian Wheezy/Testing with Python 2.7.2)
**neerbot** is the unstable bot, and runs on the lastest development version of `CloudBot`. (neerbot is running on `Debian` Wheezy/Testing with `Python` 2.7.2)
### License
CloudBot is licenced under the GPL v3 license. The terms are as follows.
## Requirements
`CloudBot` runs on `Python` 2.7.x. It is developed on `Debian` Wheezy/Testing with `Python` 2.7.2.
`Windows` users: `Windows` compatibilty is broken, but we do intend to add it back. (Eventually)
## License
`CloudBot` is licenced under the GPL v3 license. The terms are as follows.
CloudBot/DEV