wf-shadow/README.md

# wf-shadow
`wf-shadow` is a script written in order to fill the void in instant-replay software for Wayland, specifically wlroots compositors. It uses wf-recorder and wofi in order to accomplish the task.

# Dependencies
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!)
init Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-13 02:05:36 +00:00			`# wf-shadow`
Add longer description from man page to README Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-13 19:16:54 +00:00			`wf-shadow` is a script written in order to fill the void in instant-replay software for Wayland, specifically wlroots compositors. It uses wf-recorder and wofi in order to accomplish the task.
init Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-13 02:05:36 +00:00
			`# Dependencies`
			This script depends on `wf-recorder`, `wofi`, and, obviously, `bash`.

Add config file, use defaults instead of needing a monitor number, README changes Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-13 23:23:11 +00:00			`# Installation`
Add some things to README, add file location of host pidfile. Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-14 00:43:49 +00:00
Add config file, use defaults instead of needing a monitor number, README changes Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-13 23:23:11 +00:00			`## 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"`.
Add some things to README, add file location of host pidfile. Signed-off-by: Skylar "The Cobra" Widulski <cobra@vern.cc> 2023-05-14 00:43:49 +00:00
			`# 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!)`