diff options
| author | Vasudev Kamath <vasudev@copyninja.info> | 2016-10-23 21:09:40 +0530 |
|---|---|---|
| committer | Vasudev Kamath <vasudev@copyninja.info> | 2016-10-23 21:09:40 +0530 |
| commit | eda4b75b1cff83336e87da90efca9fd6b4ced2c7 (patch) | |
| tree | 491317ce50b5d19bc434ccc4b448d1bc70520177 /README.rst | |
| parent | 716c40e4ec45f8d538695225f4f06d541d959084 (diff) | |
| parent | 0f14fe83ef53b08bd8fa09670c82f4996c329bdc (diff) | |
| download | biboumi-eda4b75b1cff83336e87da90efca9fd6b4ced2c7.tar.gz biboumi-eda4b75b1cff83336e87da90efca9fd6b4ced2c7.tar.bz2 biboumi-eda4b75b1cff83336e87da90efca9fd6b4ced2c7.tar.xz biboumi-eda4b75b1cff83336e87da90efca9fd6b4ced2c7.zip | |
New upstream version 3.0upstream/3.0
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a7f9348 --- /dev/null +++ b/README.rst @@ -0,0 +1,62 @@ +Biboumi +======= + +Biboumi is an XMPP gateway that connects to IRC servers and translates +between the two protocols. It can be used to access IRC channels using any +XMPP client as if these channels were XMPP MUCs. + +It is written in modern C++14 and makes great efforts to have as little +dependencies and to be as simple as possible. + +The goal is to provide a way to access most of IRC features using any XMPP +client. It doesn’t however try to provide a complete mapping of the +features of both worlds simply because this is not useful and most probably +impossible. For example all IRC modes are not all translatable into an XMPP +features. Some of them are (like +m (mute) or +o (operator) modes), but +some others are IRC-specific. If IRC is the limiting factor (for example +you cannot have a non-ASCII nickname on IRC) then biboumi doesn’t try to +work around this issue: it just enforces the rules of the IRC server by +telling the user that he/she must choose an ASCII-only nickname. An +important goal is to keep the software (and its code) light and simple. + + +Install +------- +Refer to the INSTALL_ file. + + +Usage +----- +Read `the documentation`_. + +Authors +------- +Florent Le Coz (louiz’) <louiz@louiz.org> + + +Contact/Support +--------------- +* XMPP ChatRoom: biboumi@muc.poez.io +* Report a bug: https://dev.louiz.org/projects/biboumi/issues/new + +To contribute, the preferred way is to commit your changes on some +publicly-available git repository (your own, or github +(https://github.com/louiz/biboumi), or a fork on https://lab.louiz.org) and +to notify the developers with a ticket on the bug tracker +(https://dev.louiz.org/projects/biboumi/issues/new), a pull request on +github or a merge request on gitlab. + +Optionally you can come discuss your changes on the XMPP chat room, +beforehand. + + +Licence +------- +Biboumi is Free Software. +(learn more: http://www.gnu.org/philosophy/free-sw.html) + +Biboumi is released under the zlib license. +Please read the COPYING file for details. + +.. _INSTALL: INSTALL.rst +.. _the documentation: doc/biboumi.1.rst |