Limnoria/README.md

74 lines
2.7 KiB
Markdown
Raw Normal View History

Supybot is a robust (it doesn't crash), user friendly (it's easy to
configure) and programmer friendly (plugins are *extremely* easy to
write) Python IRC bot. It aims to be an adequate replacement for most
existing IRC bots. It includes a very flexible and powerful ACL system
for controlling access to commands, as well as more than 50 builtin plugins
providing around 400 actual commands.
Limnoria is a project which continues development of Supybot (you can
call it a fork) by fixing bugs and adding features (see the
[list of added features](https://github.com/ProgVal/Limnoria/wiki/LGC) for
more details).
# Build status
2013-01-23 17:11:52 +01:00
Master branch: [![Build Status (master branch)](https://travis-ci.org/ProgVal/Limnoria.png?branch=master)](https://travis-ci.org/ProgVal/Limnoria)
2013-01-23 17:11:52 +01:00
Testing branch: [![Build Status (testing branch)](https://travis-ci.org/ProgVal/Limnoria.png?branch=testing)](https://travis-ci.org/ProgVal/Limnoria)
2013-01-18 18:38:10 +01:00
2015-08-26 19:31:06 +02:00
Limnoria supports CPython 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, nightly;
and Pypy 2 and 3. It works best with CPython 3.3 and higher.
Python 2.5 and older versions are not supported.
2013-04-27 19:08:20 +02:00
# Support
## Documentation
2005-01-19 14:14:38 +01:00
If this is your first install, there is an [install guide](http://doc.supybot.aperio.fr/en/latest/use/install.html).
You will probably be pointed to it if you ask on IRC how to install
Limnoria.
2016-01-05 17:51:18 +01:00
There is extensive documentation at [doc.supybot.aperio.fr] and at
[Gribble wiki]. We took the time to write it; you should take the time to
read it.
## Installing from cloned repo
2015-11-29 19:04:06 +01:00
*If you don't want to clone the repo, please see the previous two
paragraphs for easier installation methods.*
```
2015-11-29 19:04:06 +01:00
git clone https://github.com/ProgVal/Limnoria.git
sudo pip install -r requirements.txt
2016-01-05 17:51:18 +01:00
sudo python setup.py install
```
alternatively without root
```
2015-11-29 19:04:06 +01:00
git clone https://github.com/ProgVal/Limnoria.git
pip install -r requirements.txt --user
python setup.py install --user
```
2005-01-19 14:14:38 +01:00
2016-01-05 17:51:18 +01:00
[doc.supybot.aperio.fr]:http://doc.supybot.aperio.fr/
[Gribble wiki]:https://sourceforge.net/p/gribble/wiki/Main_Page/
## IRC channels
### In English
If you have any trouble, feel free to swing by [#supybot and #limnoria](ircs://chat.freenode.net:6697/#supybot,#limnoria) on
[freenode](https://freenode.net/) or [#supybot](ircs://irc.oftc.net:6697/#supybot) at [OFTC](http://oftc.net/) (we have a Limnoria there relaying,
2005-01-19 14:14:38 +01:00
so either network works) and ask questions. We'll be happy to help
wherever we can. And by all means, if you find anything hard to
understand or think you know of a better way to do something,
2014-03-01 08:43:17 +01:00
*please* post it on the [issue tracker] so we can improve the bot!
2005-01-19 14:14:38 +01:00
[issue tracker]:https://github.com/ProgVal/Limnoria/issues
### In Other languages
2015-02-04 13:48:31 +01:00
Only in French at the moment, located at [#supybot-fr on freenode](ircs://chat.freenode.net:6697/#supybot-fr).