From cc2aa68d4e9ec4ad0d8cd7633f4a46469c177606 Mon Sep 17 00:00:00 2001 From: Santo Cariotti Date: Fri, 4 Dec 2020 20:16:30 +0100 Subject: docs: add readme --- README.md | 25 +++++++++++++++++++++++++ example.txt | 1 - 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 README.md delete mode 100644 example.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4a048e --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# rsanta - make your Secret Santa + +You must set environments variables for smtp: +``` +export EMAIL=youremail@tld.com +export PASSWORD=passsword +export HOST=smtp_host +``` + +Create a members file with the following syntax: +``` +// file_for_members.txt +Name Surname +Name2 Surname2 +``` + +Then build the source code: +``` +cargo build +``` + +Then call the program with the file previously created as `-f` param: +``` +/target/debug/rsanta -f +``` diff --git a/example.txt b/example.txt deleted file mode 100644 index 84d8258..0000000 --- a/example.txt +++ /dev/null @@ -1 +0,0 @@ -Santo Cariotti -- cgit v1.2.3-18-g5258