aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 5005af5..6eadaa8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,27 @@
mm3mod: Command line list moderation for mailman3
=================================================
+Prerequisites
+-------------
+
+You need a working mailman3 install, and python modules
+``mailmanclient`` and ``cmd2``.
+
Installation
------------
-Install with your favourite python package manager (not so well
-tested), or just copy ``mm3mod/__install_.py`` to a nicer name in your
-path and run it as a script.
+To try it out, you can just clone it and run
+
+::
+
+ python3 mm3mod/__init___.py
+
+To do things the pythonic way
+
+::
+
+ python3 -m pip install git+https://git.tethera.net/mm3mod.git
+
Configuration
-------------