README.rst 2.03 KB
Newer Older
1 2
Biboumi
=======
louiz’'s avatar
louiz’ committed
3

louiz’'s avatar
louiz’ committed
4
.. image:: https://lab.louiz.org/louiz/biboumi/badges/master/build.svg
5
   :target: https://lab.louiz.org/louiz/biboumi/pipelines
6

7
.. image:: https://coverity.proxy.louiz.org/projects/3726/badge.svg
8 9
   :target: https://scan.coverity.com/projects/louiz-biboumi

10
.. image:: https://coreinfrastructure.proxy.louiz.org/projects/450/badge
louiz’'s avatar
louiz’ committed
11 12
   :target: https://bestpractices.coreinfrastructure.org/projects/450

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


32
Install
louiz’'s avatar
louiz’ committed
33 34
-------
Refer to the INSTALL_ file.
35 36


louiz’'s avatar
louiz’ committed
37 38 39
Usage
-----
Read `the documentation`_.
40

41

42
Authors
louiz’'s avatar
louiz’ committed
43
-------
louiz’'s avatar
louiz’ committed
44 45
Florent Le Coz (louiz’) <louiz@louiz.org>

46 47

Contact/Support
louiz’'s avatar
louiz’ committed
48
---------------
49
* XMPP ChatRoom: biboumi@muc.poez.io
50
* Report a bug:  https://lab.louiz.org/louiz/biboumi/issues/new
louiz’'s avatar
louiz’ committed
51

louiz’'s avatar
louiz’ committed
52
Also, see the `contributing`_ page.
53

54 55

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

louiz’'s avatar
louiz’ committed
63 64
.. _INSTALL: INSTALL.rst
.. _the documentation: doc/biboumi.1.rst
louiz’'s avatar
louiz’ committed
65
.. _contributing: CONTRIBUTING.rst