From 0bf175dab2ba03cc0f3876a46e3e943e5e146948 Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Wed, 11 Feb 2026 12:12:58 +0100 Subject: improve README.md --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7698619..20506b8 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Die *Scratch HTML Galerie* erlaubt es eine einfach HTML basierte Gallery mehrerer Scratch Projekte zu erstellen. +Um Scratch-Projekte im Browser zu verwenden, wird der [TurboWarp Packager](https://github.com/TurboWarp/packager) genutzt. + ## Vorraussetzungen * Python >= 3.10 @@ -10,7 +12,7 @@ mehrerer Scratch Projekte zu erstellen. ## Verzeichnisstruktur -Das Spiel erwartet, dass das Spieleverzeichnis (`projects`) nach folgendem Muster angelegt ist: +Das Programm erwartet, dass das Projektverzeichnis (`projects`) nach folgendem Muster angelegt ist: ``` projects @@ -18,10 +20,35 @@ projects └── Klasse └── Project ├── meta.toml -- Meta Informationen zum Project - ├── Scratch Project.html -- Zu HTML exportierte Scratch Project Datei - └── Scratch Project.s3b -- oder Scratch Project Datei + ├── .html -- Zu HTML exportierte Scratch Project Datei + └── .s3b -- oder Scratch Project Datei 3 directories, 2 files ``` ## Benutzung + +Um die fertige HTML Gallery zu in einem `build` Verzeichnis zu erzeugen reicht es aus, +das `generate-gallery.py` Skript mit `python` auszuführen. + +``` +$ python3 generate-gallery.py +``` + +### Optionen + +``` +usage: generate-gallery.py [-h] [--author AUTHOR] [--title TITLE] + [--projects-dir PROJECTS_DIR] [--no-packaging] + [--output-dir OUTPUT_DIR] + +options: + -h, --help show this help message and exit + --author AUTHOR author mentioned in the HTML + --title TITLE title of the web page + --projects-dir PROJECTS_DIR + location of the projects + --no-packaging do not package all encountered scratch projects + --output-dir OUTPUT_DIR + output location of the generated HTML code +``` -- cgit v1.2.3