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).