Limnoria/README.md

[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 :)
-												Add link to the install guide in the README.

											
										
										
											2013-04-04 15:16:14 +02:00
+								[http://supybot.fr.cr/doc/use/install.html](Install guide)
 								# Build status
-												Fix order of status images.

											
										
										
											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)
-												 README: Add text before the build status image.

											
										
										
											2013-01-18 18:39:10 +01:00
-												Fix order of status images.

											
										
										
											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)
-												 README: Add build status image.

											
										
										
											2013-01-18 18:38:10 +01:00
-												Python 3.3 is not supported.

											
										
										
											2013-04-27 19:08:20 +02:00
+								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)
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								# EVERYONE:
-												README: "Convert" to markdown.

This looks normal in text editor, but GitHub shows it differently.

											
										
										
											2012-05-06 17:09:06 +02:00
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								Read [LICENSE].  It's a 3-clause BSD license, but you should read it
-												Updated README to be accurate.

											
										
										
											2005-01-25 00:01:31 +01:00
+								anyway.
-												Initial import.

											
										
										
											2005-01-19 14:14:38 +01:00
-												README.md: make LICENSE link portable & add IRC links.

											
										
										
											2012-05-26 11:34:52 +02:00
+								[LICENSE]:LICENSE.md
-												README: "Convert" to markdown.

This looks normal in text editor, but GitHub shows it differently.

											
										
										
											2012-05-06 17:09:06 +02:00
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								# USERS:
 								There is much documentation
 								at [supybot.fr.cr] and at [Gribble wiki] for your perusal.  Please read it; we took the
-												Updated README to be accurate.

											
										
										
											2005-01-25 00:01:31 +01:00
+								time to write it, you should take the time to read it.
-												Initial import.

											
										
										
											2005-01-19 14:14:38 +01:00
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								[supybot.fr.cr]:http://supybot.fr.cr/doc
 								[Gribble wiki]:https://sourceforge.net/apps/mediawiki/gribble/index.php?title=Main_Page
-												README.md: make LICENSE link portable & add IRC links.

											
										
										
											2012-05-26 11:34:52 +02:00
+								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,
-												Initial import.

											
										
										
											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,
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								*please* post it on [issue tracker] so we can improve the bot!
-												Initial import.

											
										
										
											2005-01-19 14:14:38 +01:00
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								[issue tracker]:https://github.com/ProgVal/Limnoria/issues
 								# WINDOWS USERS:
-												README: "Convert" to markdown.

This looks normal in text editor, but GitHub shows it differently.

											
										
										
											2012-05-06 17:09:06 +02:00
-												Initial import.

											
										
										
											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
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								this:
 								```
-												Update the README instructions for Windows users (most of them should have Python 2.7 by now).

											
										
										
											2013-01-23 13:44:49 +01:00
+								C:\Python27\python C:\Python27\Scripts\supybot-wizard
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								```
-												Initial import.

											
										
										
											2005-01-19 14:14:38 +01:00
-												Update the README instructions for Windows users (most of them should have Python 2.7 by now).

											
										
										
											2013-01-23 13:44:49 +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".)
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								# DEVELOPERS:
-												README: "Convert" to markdown.

This looks normal in text editor, but GitHub shows it differently.

											
										
										
											2012-05-06 17:09:06 +02:00
-												Updated README to be accurate.

											
										
										
											2005-01-25 00:01:31 +01:00
+								We likewise have tons of developer documentation at
-												README.md: Update README.

See the diff for more information.

											
										
										
											2012-05-10 10:01:20 +02:00
+								[supybot.fr.cr] for your learning adventures.  Have fun :)