Added README.md

This commit is contained in:
Dennis Nemec
2025-09-29 17:39:46 +02:00
parent 2c4bdab2f2
commit 33d39995dd

View File

@ -4,7 +4,7 @@ This program allows to automatically restart the SXP service provided by GSD Sof
If the SXP service is stuck, then log files of a specific type are being created that can be used as an indicator that the service is hanging. If the SXP service is stuck, then log files of a specific type are being created that can be used as an indicator that the service is hanging.
## Configuration ## Configuration
The configuration file **MUST** be within the same folder as the executable. The configuration file `config.toml` **MUST** be within the same folder as the executable.
1. `period` is given as seconds and determines the interval in which the destination log folder is checked. Default: 30 seconds. 1. `period` is given as seconds and determines the interval in which the destination log folder is checked. Default: 30 seconds.
2. `watch_dir` and `dir` **MUST** be absolute 2. `watch_dir` and `dir` **MUST** be absolute