From 3db172bf3be2dba4ed9b8b2571fa4c89c204f544 Mon Sep 17 00:00:00 2001 From: "Skylar \"The Cobra\" Widulski" Date: Sat, 13 May 2023 20:43:49 -0400 Subject: [PATCH] Add some things to README, add file location of host pidfile. Signed-off-by: Skylar "The Cobra" Widulski --- README.md | 14 ++++++++++++++ wf-shadow | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 900e40e..896c4d3 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,22 @@ This script depends on `wf-recorder`, `wofi`, and, obviously, `bash`. # Installation + ## Package Manager Currently, no distributions include `wf-shadow` as a package. See "Manual Installation". ## Manual Installation Put this script somewhere in your $PATH. To find which directories are in your $PATH, run `sed 's/:/\n/g' <<< "$PATH"`. + +# Contributing + +## Writing issues +Make sure to state as many details relating to wf-shadow as possible when making an issue. These include, but are not limited to: version, dependency versions, and verbose (-v) output. + +### Common issues + +#### "A wf-shadow instance is already running on display X" but no wf-shadow is running. +If you're certain wf-shadow is not running on that display, remove the file in the parentheses with `rm`. + +## Merge requests +Make sure to always keep the style of code used in wf-shadow when requesting a merge (we don't want inconsistencies or unreadable code!) diff --git a/wf-shadow b/wf-shadow index ba6ba81..e5c2187 100755 --- a/wf-shadow +++ b/wf-shadow @@ -191,7 +191,7 @@ if [ "$START" == 1 ]; then printf "%s" "$$" > "$RUNTIME"/"$MONITOR"_host.pid start else - printf "A wf-shadow instance is already running on display %d\n" "$MONITOR" + printf "A wf-shadow instance is already running on display %d (%s/%d_host.pid)\n" "$MONITOR" "$RUNTIME" "$MONITOR" fi else print_help 1