summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
authorlouiz’ <louiz@louiz.org>2018-09-03 22:26:57 +0200
committerlouiz’ <louiz@louiz.org>2018-09-03 22:26:57 +0200
commit193302b0de20df6adc090eaeaa84cfd286be724a (patch)
treeb9e0e0f75b5cd74911a42a7fcd0f1477971391ff /doc/index.rst
parent56651cb5c29cc50ddf3c62c37167fa0b9389bfde (diff)
parent28acbed948e1c281f9de6132164e42d0ed20c32f (diff)
downloadbiboumi-193302b0de20df6adc090eaeaa84cfd286be724a.tar.gz
biboumi-193302b0de20df6adc090eaeaa84cfd286be724a.tar.bz2
biboumi-193302b0de20df6adc090eaeaa84cfd286be724a.tar.xz
biboumi-193302b0de20df6adc090eaeaa84cfd286be724a.zip
Merge branch 'master' into debian
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..b97c8fd
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,23 @@
+.. 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