Limnoria/README.md
2013-04-27 19:08:20 +02:00

55 lines
2.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[http://supybot.fr.cr/doc/use/install.html](Install guide)
# Build status
Master branch: [![Build Status (master branch)](https://travis-ci.org/ProgVal/Limnoria.png?branch=master)](https://travis-ci.org/ProgVal/Limnoria)
Testing branch: [![Build Status (testing branch)](https://travis-ci.org/ProgVal/Limnoria.png?branch=testing)](https://travis-ci.org/ProgVal/Limnoria)
Limnoria is tested with Python 2.6, 2.7, 3.2, and Pypy. Python 2.5 is not supported.
Python 3.3 is not fully supported because of a [bug in Python](http://bugs.python.org/issue17856)
# EVERYONE:
Read [LICENSE]. It's a 3-clause BSD license, but you should read it
anyway.
[LICENSE]:LICENSE.md
# USERS:
There is much documentation
at [supybot.fr.cr] and at [Gribble wiki] for your perusal. Please read it; we took the
time to write it, you should take the time to read it.
[supybot.fr.cr]:http://supybot.fr.cr/doc
[Gribble wiki]:https://sourceforge.net/apps/mediawiki/gribble/index.php?title=Main_Page
If you have any trouble, feel free to swing by [#supybot and #limnoria](irc://irc.freenode.net/#supybot,#limnoria) on
[irc.freenode.net](irc://irc.freenode.net) or [#supybot](irc://irc.oftc.net/#supybot) at [irc.oftc.net](irc://irc.oftc.net) (we have a Limnoria there relaying,
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,
*please* post it on [issue tracker] so we can improve the bot!
[issue tracker]:https://github.com/ProgVal/Limnoria/issues
# WINDOWS USERS:
The wizards (supybot-wizard, supybot-newplugin, and
supybot-adduser) are all installed to your Python directory's
\Scripts. What that *probably* means is that you'll run them like
this:
```
C:\Python27\python C:\Python27\Scripts\supybot-wizard
```
If you are running a Python version that is not 2.7, replace "27" in the
file names with your Python version, without the dot (for example "26".)
# DEVELOPERS:
We likewise have tons of developer documentation at
[supybot.fr.cr] for your learning adventures. Have fun :)