README.rst
1Biboumi
2=======
3
4Biboumi is an XMPP gateway that connects to IRC servers and translates
5between the two protocols. It can be used to access IRC channels using any
6XMPP client as if these channels were XMPP MUCs.
7
8It is written in modern C++14 and makes great efforts to have as little
9dependencies and to be as simple as possible.
10
11The goal is to provide a way to access most of IRC features using any XMPP
12client. It doesn’t however try to provide a complete mapping of the
13features of both worlds simply because this is not useful and most probably
14impossible. For example all IRC modes are not all translatable into an XMPP
15features. Some of them are (like +m (mute) or +o (operator) modes), but
16some others are IRC-specific. If IRC is the limiting factor (for example
17you cannot have a non-ASCII nickname on IRC) then biboumi doesn’t try to
18work around this issue: it just enforces the rules of the IRC server by
19telling the user that he/she must choose an ASCII-only nickname. An
20important goal is to keep the software (and its code) light and simple.
21
22
23Install
24-------
25Refer to the INSTALL_ file.
26
27
28Usage
29-----
30Read `the documentation`_.
31
32
33Authors
34-------
35Florent Le Coz (louiz’) <louiz@louiz.org>
36
37
38Contact/Support
39---------------
40* XMPP ChatRoom: biboumi@muc.poez.io
41* Report a bug: https://lab.louiz.org/louiz/biboumi/issues/new
42
43Also, see the `contributing`_ page.
44
45
46Licence
47-------
48Biboumi is Free Software.
49(learn more: http://www.gnu.org/philosophy/free-sw.html)
50
51Biboumi is released under the zlib license.
52Please read the COPYING file for details.
53
54.. _INSTALL: doc/install.rst
55.. _the documentation: https://doc.biboumi.louiz.org
56.. _contributing: CONTRIBUTING.rst
57