velvettear/slideshow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fixed readme

Browse source
This commit is contained in:
Daniel Sommer 2023-11-16 15:27:48 +01:00
parent 692e6679da
commit 7af0708ea3
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,21 +1,22 @@
# slideshow
a simple cli application
a simple cli application to start a background image slideshow using 'feh'.
## requirements
- [ImageMagick](https://imagemagick.org/)
- [feh](https://feh.finalrewind.org/)
- [ImageMagick](https://imagemagick.org/) (optional)
## configuration
configuration is entirely done via environment variables.
| variable | default | description |
| SLIDESHOW_INTERVAL | 60 | the interval of the slideshow in seconds |
| SLIDESHOW_DIRECTORY | "$HOME" | path to a directory containing images |
| variable | default | description |
| -------------------- | ----------------- | -----------------------------------------------------------|
| SLIDESHOW_INTERVAL | 60 | the interval of the slideshow in seconds |
| SLIDESHOW_DIRECTORY | "$HOME" | path to a directory containing images |
| SLIDESHOW_RESOLUTION | | the resolution to which images are scaled (i.e. 1920x1080) |
| SLIDESHOW_LOGLEVEL | "info" | the log level |
| SLIDESHOW_LOGLEVEL | "info" | the log level |
**note:**
if no resolution is set the images will be displayed as they are (without any scaling).