XMPP to IRC gateway
Jonas Schäfer 3621458d3f Do not send the IRC host directly as real JID of the user 2 months ago
.gitlab/issue_templates Talk about debug logs in contributing.rst and a gitlab ticket template 1 year ago
cmake/Modules Fix the --remove pattern in lcov to exclude catch from the coverage 3 months ago
conf Remove the example values for hostname and password 3 months ago
doc Remove one of the two example conf, because one is enough 3 months ago
docker Revert "Use alpine's botan package in the docker image" 3 months ago
packaging Change the doc files listed in the spec file 3 months ago
scripts Add a documentation to explain how to migrate from sqlite3 to postgresl 11 months ago
src Do not send the IRC host directly as real JID of the user 2 months ago
tests Do not send the IRC host directly as real JID of the user 2 months ago
unit Add https to the unit file DOC thing 2 years ago
.gitignore Update .gitignore 2 years ago
.gitlab-ci.yml Only run the freebsd tests on louiz’ repository 2 months ago
CHANGELOG.rst Create subsections in the CHANGELOG 3 months ago
CMakeLists.txt Use sphinx instead of pandoc, and add a deploy job 3 months ago
COPYING Remove a useless line in the COPYING file 2 years ago
README.rst Add the homepage URL in the doc, and reformat a few paragraphs 3 months ago

README.rst

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’)


Contact/Support
---------------
* XMPP ChatRoom: biboumi@muc.poez.io
* Report a bug: https://lab.louiz.org/louiz/biboumi/issues/new

Also, see the `contributing`_ page.


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: doc/install.rst
.. _the documentation: https://doc.biboumi.louiz.org
.. _contributing: CONTRIBUTING.rst