diff options
| author | David Bremner <david@tethera.net> | 2021-08-03 08:39:04 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-08-03 08:39:38 -0400 |
| commit | a98b04255394c445ce778387cad8359b977bdbb5 (patch) | |
| tree | fcbd16d8e63726858af8df4eca718c804dc9102f | |
| parent | 14a4cd24f1a25a89e16574881869dd6036310930 (diff) | |
update README
fix typo, mention pip install and needed modules
| -rw-r--r-- | README.rst | 21 |
1 files changed, 18 insertions, 3 deletions
@@ -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 ------------- |