aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/readme.rst b/readme.rst
index 4054e79..c153b43 100644
--- a/readme.rst
+++ b/readme.rst
@@ -1,5 +1,5 @@
Cute Little Innocent Mailing List
-=================================
+#################################
climl is a simple mailing list compatible with any server supporting imap or
lmtp. I know these two protocols are not always brought together for mailing
@@ -12,3 +12,18 @@ list management, but this mailing list can be deployed in two modes:
- server mode: In this mode **climl** listen in lmtp (unix socket). A MTA,
such as postfix for example, can send mails directly to it. In this mode, we
just do not start the client bridge.
+
+Installation
+============
+
+Simply run this::
+
+ pyvenv venv-climl \
+ && venv-climl/bin/pip3 install git+git://git.devys.org/climl
+
+Running it
+==========
+
+After creating a configuration file, you can run climl by doing a::
+
+ venv-climl/bin/climl.py