diff --git a/README.md b/README.md new file mode 100644 index 0000000..a085dfd --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# TVStud Serial Mail + +Reads data from a mapping file and prepares Thunderbird drafts for serial mailing. + +### How to use: + +First, download the mapping file from `http://mapping.rfwu.de` and place it in the same folder as `serialmail.py`. + +To run, simply run `python serialmail.py --sheet SHEET_NAME`. +For example: +```bash +$ python serialmail.py --sheet Psycho --full-area-name Psychologie +``` + +You might want to add `--dry-run` first to check what emails are prepared. + +For a list of all possible arguments, run +```bash +$ python serialmail.py --help +``` diff --git a/serialmail.py b/serialmail.py index fbbc7fa..e21b850 100644 --- a/serialmail.py +++ b/serialmail.py @@ -46,7 +46,7 @@ def construct_mails( def main(): - parser = argparse.ArgumentParser("TVStud Bonn Mail") + parser = argparse.ArgumentParser("TVStud Bonn Serial Mail") parser.add_argument( "--data-file", type=Path,