Installation Guide finished and settings-parameter translated to english

Author: timluedtke

README.md

@@ -1,9 +1,9 @@
-# WiP RaspberryPi Kiosk Slideshow
+# RaspberryPi Kiosk Slideshow
 Use a RaspberryPi to show a full-screen Slideshow (Kiosk-mode)
 
 
 ## Installation TL;DR
-Use Raspbian, don't use midori
+Use Raspbian and chromium, don't use midori
 ```bash
 sudo apt-get update
 sudo apt-get upgrade
@@ -13,20 +13,13 @@ sudo apt-get install git vim ntpdate chromium-browser apache2 php libapache2-mod
 git clone git@github.com:timluedtke/raspberryPiKioskSlideshow.git
 cd raspberryPiKioskSlideshow
 mv -r ./system/lxde-pi_autostart /home/pi/.config/lxsession/LXDE-pi/autostart
-
 ```
 
-## Prepare your RaspberryPi
+## Installation - step by step
 ### Basic Setup
 For basic RaspberryPi setup you can use most of the available guides or this on:
 https://gist.github.com/blackjid/dfde6bedef148253f987
 
-### APK packages needed
-RaspberryPi Kiosk Slideshow needs:
-- apache Server with PHP module (guide: https://www.raspberrypi.org/documentation/remote-access/web-server/apache.md)
-- chromium-browser
-- ntpdate (sudo apt-get install ntpdate)
-
 ### HDMI Mode
 You may need to set the HDMI Mode on the raspi to ensure the hdmi resolution matches your screen exactly. Here is the official documentation:
 https://www.raspberrypi.org/documentation/configuration/config-txt/video.md
@@ -35,18 +28,45 @@ However I used this one:
 
 (2,82) = 1920x1080	60Hz	1080p
 
-### Autostart Slideshow on bootup
-To autostart this slideshow directly after bootup there is a precomiled file in this repo: 
-/system/lxde-pi_autostart
+### Installation of base software
+- Install **chromium** for showing the slideshow in browser
+- Install **apache** Server with PHP module for rendering the slideshow (based on this guide: https://www.raspberrypi.org/documentation/remote-access/web-server/apache.md) 
+- Install **nptupdate** to keep your Raspi-clock set correctly
 
 ```bash
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get dist-upgrade
+sudo apt-get install git vim ntpdate chromium-browser apache2 php libapache2-mod-php -y
+
+git clone git@github.com:timluedtke/raspberryPiKioskSlideshow.git
+cd raspberryPiKioskSlideshow
 mv -r ./system/lxde-pi_autostart /home/pi/.config/lxsession/LXDE-pi/autostart
 ```
 
-Guide: http://www.raspberrypi-spy.co.uk/2014/05/how-to-autostart-apps-in-rasbian-lxde-desktop/
+### Autostart Slideshow on bootup
+To autostart this slideshow directly after bootup there is a precomiled file in this repo: **/system/lxde-pi_autostart**
 
 
-https://gist.github.com/blackjid/dfde6bedef148253f987
+With the following command you can move that file to a special directory where raspberryPi automatically executes it on bootup:
+```bash
+mv -r ./system/lxde-pi_autostart /home/pi/.config/lxsession/LXDE-pi/autostart
+```
 
-## Prepare your Slideshow
+Based on this Guides: 
+- http://www.raspberrypi-spy.co.uk/2014/05/how-to-autostart-apps-in-rasbian-lxde-desktop/
+- https://gist.github.com/blackjid/dfde6bedef148253f987
 
+## Prepare your Slideshow
+Everything slideshow related happens in the /files folder.
+- Put some images to /files folder. Ideally with the same resultion of the screen (eg. 1920x1080px). 
+- Edit the slideshow.txt
+    - Every line starting with # is a comment line
+    - Every line shall be either the filename (without path) OR a URL (eg: image.jpg OR https://timluedtke.de)
+    - if you want you can set the transition delay in the comment-line: # setting-transition-delay=
+    
+## You are done now :)
+If everything is set up correctly, the RaspberryPi shall start chromium in fullscreen directly after bootup and after some seconds of showing the date&time (datetimenow.html) your slideshow shall start and loop.
+
+## Feedback
+If you liked what we've done together feel free to give feedback (Gitlab Issues) or send me an photo of your RaspberryPiKiosk Setup. I would love that :) eMail: mail %aht% timluedtke %dot% de

files/slideshow.txt

@@ -2,11 +2,11 @@
 # Configuration file for RaspberryPi Kiosk Slideshow
 #   Project author: Tim Luedtke
 #
-# Mit der folgenden Zeile kann die Wechselzeit zwischen den Übergängen (in Sekunden) festgelegt werden:
-# einstellung-wechselzeit-sekunden=7
+# With the following line you can set the transition delay between your slides:
+# setting-transition-delay=7
 #
-# Folgend können Dateien oder URLs festgelegt werden, welche aufgerufen werden sollen:
-#   Format: Dateiname oder vollständige URL (inkl. http/https)
+# You can either insert filenames (one in each line) or URL of websites:
+#   Format: Filename or complete URL (incl. http/https)
 #######################################################################################################
 1.jpg
 2.jpg
@@ -15,6 +15,7 @@
 6.jpg
 7.jpg
 9.jpg
+https://timluedtke.de
 10.jpg
 11.jpg
 12.jpg

index.php

@@ -50,7 +50,7 @@
           }
           echo "urls[" . $outputSize . "] = '" . $enhancedUrl . "';\r\n";
           $outputSize++;
-      } else if (substr($steuerungsinfos[$i], 0, 35) === "# einstellung-wechselzeit-sekunden=") {
+      } else if (substr($steuerungsinfos[$i], 0, 35) === "# setting-transition-delay=") {
           $delayvalue = substr($steuerungsinfos[$i], 35);
           $delay = $delayvalue / 2 * 1000;
       }