From f2dcc790daceddadd6727d67ed65c8639061b694 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Poulain?= <fpoulain@metrodore.fr>
Date: Mon, 24 Aug 2020 18:13:33 +0200
Subject: [PATCH] ajoute un readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e4962a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Spamotron
+
+Simple mailing script.
+
+**Table of content**
+
+- [Installation](#installation)
+- [Licence](#licence)
+
+## Installation
+### Requirements
+
+On a Debian-based host running at least Debian Stretch, you will need the
+following packages:
+- git (recommended for getting the source)
+- python3
+
+### Manual installation
+
+1.  Clone repo
+
+        $ git clone https://forge.april.org/adminsys/spamotron
+        $ chmod a+x spamotron/mailing.py
+
+2.  Try it
+
+        $ ./spamotron/mailing.py --help
+
+## License
+
+Spamotron is developed by April and licensed under the [GPLv2+](LICENSE).