This repository has been archived on 2023-04-13. You can view files and clone it, but cannot push or open issues or pull requests.
CloudBot/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

2011-11-21 00:32:16 +01:00
##CloudBot/DEV
2011-11-21 00:24:54 +01:00
2011-11-21 00:32:16 +01:00
### About
2011-11-21 00:24:54 +01:00
CloudBot is very heavily based on Skybot by rmmh. (https://github.com/rmmh/skybot)
2011-11-21 00:32:16 +01:00
### Install
2011-11-21 08:05:05 +01:00
Before you can run the bot, you need to install a few Python modules. These are *LXML*, *BeautifulSoup* and *simplejson*. On Ubuntu these can be installed using the following commands:
2011-11-21 00:24:54 +01:00
```sudo apt-get install python-lxml
```
2011-11-21 00:32:16 +01:00
2011-11-21 00:24:54 +01:00
```sudo apt-get install python-beautifulsoup
```
2011-11-21 08:05:05 +01:00
```sudo apt-get install python-simplejson
```
2011-11-21 00:24:54 +01:00
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.
2011-11-21 08:05:05 +01:00
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 :)
2011-11-21 00:24:54 +01:00
2011-11-21 00:32:16 +01:00
### Requirements
2011-11-21 00:24:54 +01:00
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.
2011-11-21 11:51:21 +01:00
### License
CloudBot is licenced under the GPL v3 license. The terms are as follows.
``` 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/>.
```