summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2013-11-27 00:43:37 +0100
committerFlorent Le Coz <louiz@louiz.org>2013-11-28 01:18:26 +0100
commit3c5cdec1d11fc03899f7068279cf5430d274124c (patch)
treec158d2f89bf80b71cd9f94beecd40ca25039f0c3 /README
parente6f20d3c0fd4ba8696a4410a366741c9b9f3562d (diff)
downloadbiboumi-3c5cdec1d11fc03899f7068279cf5430d274124c.tar.gz
biboumi-3c5cdec1d11fc03899f7068279cf5430d274124c.tar.bz2
biboumi-3c5cdec1d11fc03899f7068279cf5430d274124c.tar.xz
biboumi-3c5cdec1d11fc03899f7068279cf5430d274124c.zip
Add some documentation
Diffstat (limited to 'README')
-rw-r--r--README51
1 files changed, 51 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8a4f3b3
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+ _ _ _ _
+| |__ (_) |__ ___ _ _ _ __ ___ (_)
+| '_ \| | '_ \ / _ \| | | | '_ ` _ \| |
+| |_) | | |_) | (_) | |_| | | | | | | |
+|_.__/|_|_.__/ \___/ \__,_|_| |_| |_|_|
+
+
+Homepage: http://dev.louiz.org/projects/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++11 and make 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 theme 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 nickname only. An
+important goal is to keep the software (and its code) light and simple.
+
+================
+ Install
+================
+Refer to the INSTALL file.
+
+================
+ Authors
+================
+Florent Le Coz (louiz’) <louiz@louiz.org>
+
+=================
+ Contact/Support
+=================
+Jabber ChatRoom: biboumi@muc.poezio.eu
+Report a bug: http://dev.louiz.org/projects/biboumi/issues/new
+
+=================
+ License
+=================
+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.