From 883dbd008c90fc57c7ce30f3fa384d46449760ef Mon Sep 17 00:00:00 2001 From: Carlo Strub Date: Sun, 17 Sep 2017 01:17:58 +0200 Subject: [PATCH] update readme --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 947ede4..4c33035 100644 --- a/README.md +++ b/README.md @@ -56,19 +56,31 @@ can put in your `$PATH`. (You can also take a look at `make install` to install for you.) ## Usage -Sisyphus help can be started by running +First, set the environment variables necessary for operation: +``` +$ setenv SISYPHUS_DIRS PATHTOMAILDIR +$ setenv SISYPHUS_DURATION 24h +``` +or +``` +$ export SISYPHUS_DIRS=PATHTOMAILDIR +$ export SISYPHUS_DURATION=24h +``` +or for Windows ``` -# sisyphus help +$ set SISYPHUS_DIRS=PATHTOMAILDIR +$ set SISYPHUS_DURATION=24h ``` -To start sisyphus, do + +Sisyphus help can be started by running ``` -# sisyphus --maildir PATHTOMAILDIR run +$ sisyphus help ``` -To run it in the background, do +To start sisyphus, do ``` -# sisyphus --maildir PATHTOMAILDIR start +$ sisyphus run ``` See the help for more details.