From 08e83f0e91f8715a5e163a6e555946c9bc5bad9b Mon Sep 17 00:00:00 2001
From: Christian <info@chrosey.de>
Date: Tue, 12 May 2020 18:06:44 +0200
Subject: [PATCH] [DOC] Add Documentation

---
 README.md                   | 36 ++++++++++++++++++++++++++++++++++++
 src/js/chrosey.slideshow.js |  3 ++-
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2755826
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Restaurant1894 Webseite
+
+Webseitendaten für die Homepage des Theaterrestaurants 1894.
+
+[Link zur Webseite](http://restaurant1894.de)
+
+## Bilder in der Gallerie verwalten
+In der Datei `js/chrosey.slideshow.js` werden die Bilder und deren Metadaten verwaltet.
+
+im Bereich `// Anzuzeigende Bilder`
+wird der Bildname aus dem Ordner `img/gallery/` entnommen (ohne `.jpg`). Folgende Struktur steht zur Verwaltung eines einzelnen Bildes zur Verfügung:
+```js
+{
+    path: "Restaurant14",
+    alt: "Eine dampfende Espressotasse mit Anrichtung",
+    title: "Wie wäre es mit einem Espresso?"
+},
+```
+- `path` ist der Bildname:  
+  die Datei muss im oben genannten Verzeichnis vorhanden sein (am besten auch in `img/gallery/thumbs/`)
+- `alt` ist der Alternativtext (wird für Blinde vorgelesen):  
+  er sollte immer eine Beschreibung des gezeigten enthalten (Barrierefreiheit)
+- `title` erscheint unter dem Angezeigtem Bild als Text:  
+  er kann Freitext enthalten (wenn nicht vorhanden wird stattdessen `alt` unter dem Bild angezeigt)
+
+## Bilder für die Webseite skalieren
+Ein neues Bild: 
+- Format `.jpg` 
+- Maximale Auflösung
+  - für Galleriebilder  `1200px * 900px` und
+  - für deren Vorschaubilder `100px * 100px` 
+  - für Hindergrundbilder `2400px * 1800px`
+- progressiv sein, damit es für langsame Verbindungen besser dargestellt wird
+- einen passenden Namen haben
+- im entsprechenden Ordner abgelegt werden (`img/(gallery|backgrounds`))
+
diff --git a/src/js/chrosey.slideshow.js b/src/js/chrosey.slideshow.js
index c165f07..075c627 100755
--- a/src/js/chrosey.slideshow.js
+++ b/src/js/chrosey.slideshow.js
@@ -23,7 +23,7 @@ $(function () {
 			'top': galleryMargin
 		})
 	}
-
+	// Anzuzeigende Bilder
 	let imagesToLoad = [{
 			path: "Restaurant06",
 			alt: "Eingang zu unserem Restaurant vom Theaterfoyer"
@@ -165,6 +165,7 @@ $(function () {
 			alt: "So geht es in der Küche zu"
 		}
 	];
+	// Ende Anzuzeigende Bilder 
 
 	imagesToLoad.forEach(function (element) {
 		var item = '<li><a href="img/gallery/' +