From 480ffba3f9f1e9679eef3824676f444c93c9b40d Mon Sep 17 00:00:00 2001 From: nerf van nerfingen Date: Mon, 14 Nov 2022 11:59:04 +0100 Subject: [PATCH] added first readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b6cb17..419bfdc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ +[TOC] + # choirMail -send a weekly mail automatically \ No newline at end of file +send a weekly mail automatically + +## Building +Just run `nix build`. + +## Running +Just run the binary to send a mail, it requires exactly one +parameter that points to a config file. + +### Configuration +The config file is a toml file, even though it as of now makes not really use +of any toml features. + +```toml +mailDomain = "the domain of the smtp server to send messages with" +mailUser = "the username on the smtp server" +mailPassword = "the passwond on the smtp server" +mailTo = "the mail to send to" +mailFrom = "the sender of the mail" +mailErrorTo = "the address to send a mail to in case of error" +``` + +## Develop +If you run `nix develop` you get a set up kakoune with an lsp. Be aware +this depends on your local cabal cache. + +# TODO +- Better E-Mail generation +- Add the nix modules to the flake +- Better Error handling + - Find out which exceptions the SMTP module throws +