diff --git a/README.md b/README.md new file mode 100644 index 0000000..6dd8633 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Automatically fetches email titles for FSR MaPhy mailing list (by default for the last week) and formats in TeX code + +To run, it needs log in credentials, provided via the environment: +´´´ +IMAP_PASSWORD +IMAP_EMAIL +IMAP_SERVER (defaults to 'imap.uni-potsdam.de') +IMAP_FOLDER (defaults to 'Uni Mail/FSR', change this to the folder that contains only your [FSR MaPhy] mails, for example with Thunderbird message filters) +IMAP_CUTOFF (iso string of cutoff date (inclusive), defaults to one week) +´´´ + +call via + +``` + IMAP_PASSWORD=mypass python3 main.py +``` + +note the leading space, to not save password to bash/zsh history