Improve README documentation
This commit is contained in:
parent
09465d675a
commit
da920d46b8
1 changed files with 33 additions and 54 deletions
87
README.md
87
README.md
|
|
@ -1,62 +1,41 @@
|
|||
# eis-website
|
||||
|
||||
## Pfad auf dem Server
|
||||
`/home/komane/public_html`
|
||||
Eine einfache Website mit mehreren statischen Seiten und einigen interaktiven Funktionen.
|
||||
|
||||
## Struktur
|
||||
.
|
||||
│― 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
|
||||
## Überblick
|
||||
Dieses Projekt enthält die Startseite, Informationsseiten, ein Notenrechner-Tool und ein kleines Quiz.
|
||||
|
||||
## Dateien
|
||||
- **index.html** — Startseite der Website
|
||||
- **about_us.html** — Vorstellung des Teams oder Unternehmens
|
||||
- **contact.html** — Kontaktformular oder Kontaktdaten
|
||||
- **eis_project.html** — Projektbeschreibung
|
||||
- **imprint.html** — Impressum
|
||||
- **notenrechner.html** — Notenberechnungstool
|
||||
- **quiz.html** — Mini-Quiz mit drei Fragen
|
||||
- **css/style.css** — Layout, Farben, Dark Mode, Tageszeit-Farben, Quiz-Design
|
||||
- **js/script.js** — Begrüßung, Tageszeit-Farben, Dark Mode, Galerie-Zoom
|
||||
- **js/quiz.js** — Quiz-Logik, direkte Rückmeldung, Auswertung
|
||||
- **img/Logo.png** — Logo der Website
|
||||
- **assets/** — zusätzliche Dateien (Medien, Dokumente)
|
||||
- **.gitignore** — Ausschlussregeln für Git
|
||||
- **README.md** — Dokumentation der Struktur und Features
|
||||
## Ordnerstruktur
|
||||
- index.html — Startseite
|
||||
- about_us.html — Vorstellung des Teams oder Unternehmens
|
||||
- contact.html — Kontaktinformationen
|
||||
- eis_project.html — Projektbeschreibung
|
||||
- imprint.html — Impressum
|
||||
- notenrechner.html — Notenberechnungstool
|
||||
- quiz.html — Mini-Quiz
|
||||
- css/style.css — Stylesheet für das Layout und die Design-Elemente
|
||||
- js/script.js — Begrüßung, Dark Mode, Galerie-Zoom und weitere Interaktionen
|
||||
- js/quiz.js — Quiz-Logik und Auswertung
|
||||
- img/Logo.png — Logo der Website
|
||||
- assets/ — zusätzliche Dateien wie Bilder, Icons oder PDFs
|
||||
|
||||
## Features
|
||||
- **Begrüßung nach Tageszeit**
|
||||
- Dynamischer Text abhängig von der Uhrzeit (script.js)
|
||||
- Farbige Darstellung je nach Tageszeit (morgen/tag/abend)
|
||||
- Eingebunden in index.html und css/style.css
|
||||
## Funktionen
|
||||
- Begrüßung je nach Tageszeit
|
||||
- Umschaltbarer Dark Mode
|
||||
- Galerie-Zoom auf Bildern
|
||||
- Quiz mit direkter Rückmeldung
|
||||
- Notenrechner für einfache Berechnungen
|
||||
|
||||
- **Dark Mode**
|
||||
- Umschaltbar per Button
|
||||
- Zustand wird in localStorage gespeichert
|
||||
## Lokal ansehen
|
||||
1. Öffne die Datei index.html direkt im Browser, oder
|
||||
2. starte einen lokalen Server mit:
|
||||
- Python: `python -m http.server 8000`
|
||||
3. Öffne danach: `http://localhost:8000`
|
||||
|
||||
- **Galerie-Zoom**
|
||||
- Klick auf ein Bild öffnet eine vergrößerte Ansicht
|
||||
## Bereitstellung
|
||||
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)**
|
||||
- Animierter Balken, der sich per Button füllt
|
||||
|
||||
## Verlinkungen
|
||||
- **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)
|
||||
## Technologien
|
||||
- HTML
|
||||
- CSS
|
||||
- JavaScript
|
||||
|
|
|
|||
Loading…
Reference in a new issue