Limnoria/README.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

[http://supybot.fr.cr/doc/use/install.html](Install guide)
# Build status
(Currently broken because of a bug in Travis)
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
# EVERYONE:
Read [LICENSE]. It's a 3-clause BSD license, but you should read it
2005-01-25 00:01:31 +01:00
anyway.
2005-01-19 14:14:38 +01:00
[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
2005-01-25 00:01:31 +01:00
time to write it, you should take the time to read it.
2005-01-19 14:14:38 +01:00
[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,
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,
*please* post it on [issue tracker] so we can improve the bot!
2005-01-19 14:14:38 +01:00
[issue tracker]:https://github.com/ProgVal/Limnoria/issues
# WINDOWS USERS:
2005-01-19 14:14:38 +01:00
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
```
2005-01-19 14:14:38 +01:00
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:
2005-01-25 00:01:31 +01:00
We likewise have tons of developer documentation at
[supybot.fr.cr] for your learning adventures. Have fun :)