minor changes to README.md and some variable refactorings

timluedtke · timluedtke · commit 1eb9563bb6d7 · 2025-04-30T11:36:25.000+02:00
diff --git a/README.md b/README.md
@@ -3,16 +3,19 @@ Use a RaspberryPi to show a full-screen Slideshow (Kiosk-mode)
 
 
 ## Installation TL;DR
-Use Raspbian and chromium, don't use midori
+We assume you have a RaspberryPi with Raspbian installed and a working internet connection.
 ```bash
-sudo apt-get update && sudo apt-get dist-upgrade
-sudo apt-get install git vim ntpdate chromium-browser apache2 php libapache2-mod-php -y
+sudo apt-get update && sudo apt-get upgrade
+sudo apt-get install git 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
 ```
 
+### ntpdate
+To keep the clock of your RaspberryPi up to date we use ntpdate. This is a simple command line tool that sets the date and time via NTP (Network Time Protocol).
+
 ## Installation - step by step
 ### Basic Setup
 For basic RaspberryPi setup you can use most of the available guides, for example this one:
@@ -32,10 +35,8 @@ However I used this one:
 - 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
+sudo apt-get update && sudo apt-get upgrade
+sudo apt-get install git ntpdate chromium-browser apache2 php libapache2-mod-php -y
 
 git clone git@github.com:timluedtke/raspberryPiKioskSlideshow.git
 cd raspberryPiKioskSlideshow
@@ -59,7 +60,7 @@ Based on this Guides:
 Everything slideshow-related happens in the ./files folder.
 - Put some images into the /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 starting with # is a comment line (except the transition delay setting)
     - Every other 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 to a different value (seconds): # setting-transition-delay=
     
diff --git a/index.php b/index.php
@@ -33,61 +33,61 @@
   </style>
 </head>
 <body>
-<iframe src="datetimenow.html" id="fristFrame" style="visibility: hidden;"></iframe>
+<iframe src="datetimenow.html" id="firstFrame" style="visibility: hidden;"></iframe>
 <iframe src="datetimenow.html" id="secondFrame" style="visibility: visible;"></iframe>
 <script type="text/javascript">
   var urls = [];
   <?php
-  $steuerungsinfos = file("./files/slideshow.txt");
+  $slideshow = file("./files/slideshow.txt");
   $outputSize = 0;
   $delay = 14 / 2 * 1000;
 
-  for ($i = 0; $i < count($steuerungsinfos); $i++) {
-      if (!(substr($steuerungsinfos[$i], 0, 1) === "#")) {
-          $enhancedUrl = trim($steuerungsinfos[$i]);
+  for ($i = 0; $i < count($slideshow); $i++) {
+      if (!(substr($slideshow[$i], 0, 1) === "#")) {
+          $enhancedUrl = trim($slideshow[$i]);
           if (!(substr($enhancedUrl, 0, 4) === "http")) {
               $enhancedUrl = "./files/" . $enhancedUrl;
           }
           echo "urls[" . $outputSize . "] = '" . $enhancedUrl . "';\r\n";
           $outputSize++;
-      } else if (substr($steuerungsinfos[$i], 0, 35) === "# setting-transition-delay=") {
-          $delayvalue = substr($steuerungsinfos[$i], 35);
+      } else if (substr($slideshow[$i], 0, 35) === "# setting-transition-delay=") {
+          $delayvalue = substr($slideshow[$i], 35);
           $delay = $delayvalue / 2 * 1000;
       }
   }
   echo "var delay = " . $delay . ";\r\n";
   ?>
-  var urlaktuell = 0;
-  setTimeout("loadIntoFristFrame()", 1000);
+  var urlnow = 0;
+  setTimeout("loadIntoFirstFrame()", 1000);
 
-  function loadIntoFristFrame() {
-    document.getElementById('fristFrame').src = urls[urlaktuell];
-    urlaktuell++;
-    if (urlaktuell === urls.length) {
-      urlaktuell = 0;
+  function loadIntoFirstFrame() {
+    document.getElementById('firstFrame').src = urls[urlnow];
+    urlnow++;
+    if (urlnow === urls.length) {
+      urlnow = 0;
     }
     setTimeout("switchToFirstFrame()", delay);
   }
 
   function switchToFirstFrame() {
-    document.getElementById('fristFrame').style.visibility = 'visible';
+    document.getElementById('firstFrame').style.visibility = 'visible';
     document.getElementById('secondFrame').style.visibility = 'hidden';
     setTimeout("loadIntoSecondFrame()", delay);
   }
 
   function loadIntoSecondFrame() {
-    document.getElementById('secondFrame').src = urls[urlaktuell];
-    urlaktuell++;
-    if (urlaktuell === urls.length) {
-      urlaktuell = 0;
+    document.getElementById('secondFrame').src = urls[urlnow];
+    urlnow++;
+    if (urlnow === urls.length) {
+      urlnow = 0;
     }
     setTimeout("switchToSecondFrame()", delay);
   }
 
   function switchToSecondFrame() {
-    document.getElementById('fristFrame').style.visibility = 'hidden';
+    document.getElementById('firstFrame').style.visibility = 'hidden';
     document.getElementById('secondFrame').style.visibility = 'visible';
-    setTimeout("loadIntoFristFrame()", delay);
+    setTimeout("loadIntoFirstFrame()", delay);
   }
 </script>
 </body>
diff --git a/version b/version
@@ -1 +1 @@
-1.3.0
+1.3.1
