diff options
| author | Santo Cariotti <santo@dcariotti.me> | 2020-12-04 20:16:30 +0100 |
|---|---|---|
| committer | Santo Cariotti <santo@dcariotti.me> | 2020-12-04 20:16:30 +0100 |
| commit | cc2aa68d4e9ec4ad0d8cd7633f4a46469c177606 (patch) | |
| tree | c780a7b1136b97b128f8f8f2eda09889c54073c0 | |
| parent | 5fbde347a9df39a5c1d4eb4356690c9e4449c075 (diff) | |
docs: add readme
| -rw-r--r-- | README.md | 25 | ||||
| -rw-r--r-- | example.txt | 1 |
2 files changed, 25 insertions, 1 deletions
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 <email@tld.com> +Name2 Surname2 <email2@tld.com> +``` + +Then build the source code: +``` +cargo build +``` + +Then call the program with the file previously created as `-f` param: +``` +/target/debug/rsanta -f <file_for_members.txt> +``` 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 <santo@dcariotti.me> |