summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..819a3e5
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,24 @@
+.. biboumi documentation master file, created by
+ sphinx-quickstart on Mon Aug 27 19:50:26 2018.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Biboumi – XMPP gateway to IRC
+=============================
+
+Homepage: https://biboumi.louiz.org
+
+Forge: https://lab.louiz.org/louiz/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.
+
+.. toctree::
+ :maxdepth: 2
+
+ install
+ admin
+ user
+ contributing
+ developer