slideshow/README.md

29 lines
856 B
Markdown
Raw Normal View History

2023-11-16 15:26:24 +01:00
# slideshow
a simple cli application
## requirements
- [ImageMagick](https://imagemagick.org/)
- [feh](https://feh.finalrewind.org/)
## 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 |
| SLIDESHOW_RESOLUTION | | the resolution to which images are scaled (i.e. 1920x1080) |
| SLIDESHOW_LOGLEVEL | "info" | the log level |
**note:**
if no resolution is set the images will be displayed as they are (without any scaling).
**available log levels:**
- `debug`
- `info`
- `warning`
- `error`
- `fatal`