Improve README documentation

README.md

@@ -1,62 +1,41 @@
 # eis-website
 
-## Pfad auf dem Server
+Eine einfache Website mit mehreren statischen Seiten und einigen interaktiven Funktionen.
-`/home/komane/public_html`
 
-## Struktur
+## Überblick
-.
+Dieses Projekt enthält die Startseite, Informationsseiten, ein Notenrechner-Tool und ein kleines Quiz.
-│― index.html  
-│― about_us.html  
-│― contact.html  
-│― eis_project.html  
-│― imprint.html  
-│― notenrechner.html  
-│― css/  
-│   └── style.css  
-│― js/  
-│   └── script.js  
-│― img/  
-│   └── Logo.png  
-│― assets/  
-│   └── diverse Dateien (PDFs, Bilder, Icons)  
-│― .gitignore  
-└── README.md  
 
-## Dateien
+## Ordnerstruktur
-- **index.html** — Startseite der Website  
+- index.html — Startseite
-- **about_us.html** — Vorstellung des Teams oder Unternehmens  
+- about_us.html — Vorstellung des Teams oder Unternehmens
-- **contact.html** — Kontaktformular oder Kontaktdaten  
+- contact.html — Kontaktinformationen
-- **eis_project.html** — Projektbeschreibung  
+- eis_project.html — Projektbeschreibung
-- **imprint.html** — Impressum  
+- imprint.html — Impressum
-- **notenrechner.html** — Notenberechnungstool  
+- notenrechner.html — Notenberechnungstool
-- **quiz.html** — Mini-Quiz mit drei Fragen  
+- quiz.html — Mini-Quiz
-- **css/style.css** — Layout, Farben, Dark Mode, Tageszeit-Farben, Quiz-Design  
+- css/style.css — Stylesheet für das Layout und die Design-Elemente
-- **js/script.js** — Begrüßung, Tageszeit-Farben, Dark Mode, Galerie-Zoom  
+- js/script.js — Begrüßung, Dark Mode, Galerie-Zoom und weitere Interaktionen
-- **js/quiz.js** — Quiz-Logik, direkte Rückmeldung, Auswertung  
+- js/quiz.js — Quiz-Logik und Auswertung
-- **img/Logo.png** — Logo der Website  
+- img/Logo.png — Logo der Website
-- **assets/** — zusätzliche Dateien (Medien, Dokumente)  
+- assets/ — zusätzliche Dateien wie Bilder, Icons oder PDFs
-- **.gitignore** — Ausschlussregeln für Git  
-- **README.md** — Dokumentation der Struktur und Features  
 
-## Features
+## Funktionen
-- **Begrüßung nach Tageszeit**  
+- Begrüßung je nach Tageszeit
-  - Dynamischer Text abhängig von der Uhrzeit (script.js)  
+- Umschaltbarer Dark Mode
-  - Farbige Darstellung je nach Tageszeit (morgen/tag/abend)  
+- Galerie-Zoom auf Bildern
-  - Eingebunden in index.html und css/style.css  
+- Quiz mit direkter Rückmeldung
+- Notenrechner für einfache Berechnungen
 
-- **Dark Mode**  
+## Lokal ansehen
-  - Umschaltbar per Button  
+1. Öffne die Datei index.html direkt im Browser, oder
-  - Zustand wird in localStorage gespeichert  
+2. starte einen lokalen Server mit:
+   - Python: `python -m http.server 8000`
+3. Öffne danach: `http://localhost:8000`
 
-- **Galerie-Zoom**  
+## Bereitstellung
-  - Klick auf ein Bild öffnet eine vergrößerte Ansicht  
+Die Website ist für den Einsatz im Serverordner `/home/komane/public_html` vorgesehen. Achte darauf, dass die Ordner `css`, `js`, `img` und `assets` zusammen mit den HTML-Dateien hochgeladen werden.
 
-- **Fortschrittsbalken (Roundtrip 3)**  
+## Technologien
-  - Animierter Balken, der sich per Button füllt  
+- HTML
-
+- CSS
-## Verlinkungen
+- JavaScript
-- **index.html → css/style.css**  
-- **index.html → img/Logo.png**  
-- **index.html → imprint.html**  
-- **Navigation → about_us.html, contact.html, eis_project.html, quiz.html, notenrechner.html**  
-- **Unterseiten → ../css/style.css** (eine Ebene höher)