ajoute un readme

This commit is contained in:
François Poulain 2020-08-24 18:13:33 +02:00
parent 37925ccafd
commit f2dcc790da
1 changed files with 31 additions and 0 deletions

31
README.md Normal file
View File

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