update the readme so it's accurate now about config directory information, also specify that sigkill is terminate

master
rascul 2 years ago
parent 0fc873e965
commit e94dc3f327

@ -1,16 +1,9 @@
[![Pipeline Status](https://gitlab.com/rascul/sup/badges/master/pipeline.svg)](https://gitlab.com/rascul/sup/pipelines) [![Pipeline Status](https://gitlab.com/rascul/sup/badges/master/pipeline.svg)](https://gitlab.com/rascul/sup/pipelines)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitlab.com/rascul/sup/blob/master/LICENSE) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitlab.com/rascul/sup/blob/master/LICENSE)
THIS README PROBABLY ISN'T UP TO DATE DON'T USE THIS SOFTWARE IT WILL
BREAK EVERYTHING AND DESTROY ALL YOU HOLD DEAR
Sup is a small process supervisor. It is originally to monitor some Sup is a small process supervisor. It is originally to monitor some
applications in my X session but it can be used for other things. applications in my X session but it can be used for other things.
## THIS IS WRONG
some things in this readme are wrong and you shouldn't use this anyway
## Installing ## Installing
```shell ```shell
@ -21,7 +14,9 @@ $ cargo install --path .
## Running ## Running
Sup must find the config file sup.toml in the current directory. Sup must find the config file apps.toml in the config directory. By default
this is `~/.config/sup` but can be set with `-c /path/to/directory`. Also
inside this directory is where the log file will be stored.
## Features ## Features
@ -34,7 +29,8 @@ conditions sup can watch for:
exit status is 0. exit status is 0.
* Failure: If the application exits with a non zero exit status it is * Failure: If the application exits with a non zero exit status it is
considered to have failed. considered to have failed.
* Terminated: The application was killed by some other mechanism. * Terminated: The application was killed by some other mechanism, such as with
SIGKILL.
### Holds ### Holds
@ -83,7 +79,6 @@ wait = true
[[app]] [[app]]
name = "terminal" name = "terminal"
command = "alacritty" command = "alacritty"
args = []
restart_on_success = false restart_on_success = false
restart_on_failure = true restart_on_failure = true
restart_on_terminate = true restart_on_terminate = true
@ -97,6 +92,5 @@ args = ["-e", "env"]
[[app]] [[app]]
name = "window manager" name = "window manager"
command = "twm" command = "twm"
args = []
hold = true hold = true
``` ```

Loading…
Cancel
Save