mirror of
https://github.com/Mikaela/Limnoria.git
synced 2026-05-16 04:18:00 +02:00
833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason.
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 the project which continues development of Supybot since 2010. # Build status Master branch: [](https://travis-ci.org/ProgVal/Limnoria) Testing branch: [](https://travis-ci.org/ProgVal/Limnoria) Limnoria supports CPython 3.4 to 3.9, CPython nightly, and Pypy 3. # Support ## Documentation If this is your first install, there is an [install guide](https://docs.limnoria.net/en/latest/use/install.html). You will probably be pointed to it if you ask on IRC how to install Limnoria. TL;DR version: ``` sudo apt-get install python3 python3-pip python3-wheel pip3 install --user limnoria # You might need to add $HOME/.local/bin to your PATH supybot-wizard ``` There is extensive documentation at [docs.limnoria.net] and at [Gribble wiki]. We took the time to write it; you should take the time to read it. [docs.limnoria.net]:https://docs.limnoria.net/ [Gribble wiki]:https://sourceforge.net/p/gribble/wiki/Main_Page/ ## IRC channels ### In English If you have any trouble, feel free to swing by [#limnoria](ircs://chat.freenode.net:6697/#limnoria) on [freenode](https://freenode.net/) 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 the [issue tracker] so we can improve the bot! [issue tracker]:https://github.com/ProgVal/Limnoria/issues ### In Other languages Only in French at the moment, located at [#supybot-fr on freenode](ircs://chat.freenode.net:6697/#supybot-fr).