initial commit

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7698619
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Scratch HTML Galerie
+
+Die *Scratch HTML Galerie* erlaubt es eine einfach HTML basierte Gallery
+mehrerer Scratch Projekte zu erstellen. 
+
+## Vorraussetzungen
+
+* Python >= 3.10
+* (npm) um Scratch Projekte lokal zu HTML zu konvertieren
+
+## Verzeichnisstruktur
+
+Das Spiel erwartet, dass das Spieleverzeichnis (`projects`) nach folgendem Muster angelegt ist:
+
+```
+projects
+└── Jahrgang
+    └── Klasse
+        └── Project
+            ├── meta.toml -- Meta Informationen zum Project
+            ├── Scratch Project.html -- Zu HTML exportierte Scratch Project Datei
+            └── Scratch Project.s3b -- oder Scratch Project Datei
+
+3 directories, 2 files
+```
+
+## Benutzung