From 7af0708ea357a33c2e146f1be2a86a40de80bad3 Mon Sep 17 00:00:00 2001 From: velvettear Date: Thu, 16 Nov 2023 15:27:48 +0100 Subject: [PATCH] fixed readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ca2ad0c..41868e2 100644 --- a/README.md +++ b/README.md @@ -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).