README.rst 2 KB
Newer Older
1 2
Biboumi
=======
louiz’'s avatar
louiz’ committed
3 4 5 6 7

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.

louiz’'s avatar
louiz’ committed
8
It is written in modern C++14 and makes great efforts to have as little
louiz’'s avatar
louiz’ committed
9 10 11 12 13 14
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
louiz’'s avatar
louiz’ committed
15
features.  Some of them are (like +m (mute) or +o (operator) modes), but
louiz’'s avatar
louiz’ committed
16 17 18
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
louiz’'s avatar
louiz’ committed
19
telling the user that he/she must choose an ASCII-only nickname.  An
louiz’'s avatar
louiz’ committed
20 21 22
important goal is to keep the software (and its code) light and simple.


23
Install
louiz’'s avatar
louiz’ committed
24 25
-------
Refer to the INSTALL_ file.
26 27


louiz’'s avatar
louiz’ committed
28 29 30
Usage
-----
Read `the documentation`_.
31 32

Authors
louiz’'s avatar
louiz’ committed
33
-------
louiz’'s avatar
louiz’ committed
34 35
Florent Le Coz (louiz’) <louiz@louiz.org>

36 37

Contact/Support
louiz’'s avatar
louiz’ committed
38
---------------
39 40
* XMPP ChatRoom: biboumi@muc.poez.io
* Report a bug:  https://dev.louiz.org/projects/biboumi/issues/new
louiz’'s avatar
louiz’ committed
41

42 43 44 45 46 47 48 49 50 51
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.

52 53

Licence
louiz’'s avatar
louiz’ committed
54
-------
louiz’'s avatar
louiz’ committed
55 56 57 58 59
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.
60

louiz’'s avatar
louiz’ committed
61 62
.. _INSTALL: INSTALL.rst
.. _the documentation: doc/biboumi.1.rst