update readme

master
Carlo Strub 7 years ago
parent 8350f59e88
commit 883dbd008c

@ -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.

Loading…
Cancel
Save