From e94dc3f3279b0db39523e3fe69801d46c01a3501 Mon Sep 17 00:00:00 2001 From: rascul Date: Sat, 23 Jul 2022 17:05:09 -0500 Subject: [PATCH] update the readme so it's accurate now about config directory information, also specify that sigkill is terminate --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c31656f..fe07a80 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,9 @@ [![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) -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 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 ```shell @@ -21,7 +14,9 @@ $ cargo install --path . ## 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 @@ -34,7 +29,8 @@ conditions sup can watch for: exit status is 0. * Failure: If the application exits with a non zero exit status it is 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 @@ -83,7 +79,6 @@ wait = true [[app]] name = "terminal" command = "alacritty" -args = [] restart_on_success = false restart_on_failure = true restart_on_terminate = true @@ -97,6 +92,5 @@ args = ["-e", "env"] [[app]] name = "window manager" command = "twm" -args = [] hold = true ```