~singpolyma/biboumi

ref: 479708c83eeea96986692ccf85cf06944a1ca919 biboumi/README.rst -rw-r--r-- 2.5 KiB
479708c8 — louiz’ Add an other kewl badge 7 years ago
                                                                                
b32729fb louiz’
3c5cdec1 Florent Le Coz
20a06c95 louiz
b7f02f79 louiz’
479708c8 louiz’
3c5cdec1 Florent Le Coz
c6059e5a Florent Le Coz
3c5cdec1 Florent Le Coz
39175e1a Florent Le Coz
3c5cdec1 Florent Le Coz
39175e1a Florent Le Coz
3c5cdec1 Florent Le Coz
b32729fb louiz’
6f3dacc4 louiz’
b32729fb louiz’
6f3dacc4 louiz’
b32729fb louiz’
3047bd41 louiz’
b32729fb louiz’
6f3dacc4 louiz’
3c5cdec1 Florent Le Coz
b32729fb louiz’
6f3dacc4 louiz’
b32729fb louiz’
183f53d0 louiz’
3c5cdec1 Florent Le Coz
13eceeee Florent Le Coz
183f53d0 louiz’
13eceeee Florent Le Coz
b32729fb louiz’
6f3dacc4 louiz’
3c5cdec1 Florent Le Coz
b32729fb louiz’
6f3dacc4 louiz’
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
Biboumi
=======

.. image:: https://lab.louiz.org/louiz/biboumi/badges/master/build.svg
   :target: https://lab.louiz.org/louiz/biboumi/commits/master
   
.. image:: https://lab.louiz.org/louiz/biboumi/badges/master/coverage.svg
   :target: https://lab.louiz.org/louiz/biboumi/commits/master

.. image:: https://scan.coverity.com/projects/3726/badge.svg
   :target: https://scan.coverity.com/projects/louiz-biboumi

.. image:: https://bestpractices.coreinfrastructure.org/projects/450/badge
   :target: https://bestpractices.coreinfrastructure.org/projects/450

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://lab.louiz.org/louiz/biboumi/issues/new

To contribute, the preferred way is to commit your changes on some
publicly-available git repository (a fork on gitlab or github or on your own
repository) and to notify the developers with a ticket on the bug tracker,
or a merge request on gitlab or a pull request on github.

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