From 5c928e565adb046e526c0977d698ad775e41bb5a Mon Sep 17 00:00:00 2001 From: "Max P." Date: Sun, 15 Jun 2025 16:35:28 +0200 Subject: [PATCH] docs(readme): update structure and tables for improved clarity --- README.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index a749739..1959e0e 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,16 @@ externe Abhängigkeiten verteilen möchtest. ## Inhalt -1. [Funktionsweise](#funktionsweise) -2. [Voraussetzungen](#voraussetzungen) -3. [Schnellstart](#schnellstart) -4. [Beispiele](#beispiele) -5. [Erklärung der Parameter](#erklärung-der-parameter) -6. [Dateiaufbau des SFX](#dateiaufbau-des-sfx) -7. [Troubleshooting](#troubleshooting) -8. [Lizenz](#lizenz) +- [Self-Extracting Archive (SFX) Builder](#self-extracting-archive-sfx-builder) + - [Inhalt](#inhalt) + - [Funktionsweise](#funktionsweise) + - [Voraussetzungen](#voraussetzungen) + - [Schnellstart](#schnellstart) + - [Beispiele](#beispiele) + - [Erklärung der Parameter](#erklärung-der-parameter) + - [Dateiaufbau des SFX](#dateiaufbau-des-sfx) + - [Troubleshooting](#troubleshooting) + - [Lizenz](#lizenz) --- @@ -38,13 +40,13 @@ externe Abhängigkeiten verteilen möchtest. ## Voraussetzungen -| Tool | Zweck | Getestete Version | -|-----------------|----------------------------|-------------------| -| `bash` | Shell-Interpreter | ≥ 4.2 | -| `tar` | Paketierung | _(coreutils)_ | -| `zstd` | Kompression | ≥ 1.5 | -| `numfmt` | Menschliche Größenangaben | _(coreutils)_ | -| GNU `sed`, `grep`, `cut`, `wc`, `mktemp` | Hilfs-Tools | _(coreutils)_ | +| Tool | Zweck | Getestete Version | +| ---------------------------------------- | ------------------------- | ----------------- | +| `bash` | Shell-Interpreter | ≥ 4.2 | +| `tar` | Paketierung | _(coreutils)_ | +| `zstd` | Kompression | ≥ 1.5 | +| `numfmt` | Menschliche Größenangaben | _(coreutils)_ | +| GNU `sed`, `grep`, `cut`, `wc`, `mktemp` | Hilfs-Tools | _(coreutils)_ | > **Tipp:** Unter Debian/Ubuntu genügt: > `sudo apt install zstd coreutils` @@ -89,11 +91,11 @@ bash -x cool_tool.run --version ## Erklärung der Parameter -| Option | Alias | Pflicht? | Beschreibung | -|----------------------------|-------|----------|--------------------------------------------------| -| `--payload-dir ` | `-p` | ✅ | Verzeichnis mit allen zu verteilenden Dateien | -| `--entrypoint ` | `-e` | ✅ | Ausführbare Datei *innerhalb* von **DIR** | -| `--output ` | `-o` | ❌ | Zielpfad der erzeugten `.run`-Datei (Default: `sfx.run`) | +| Option | Alias | Pflicht? | Beschreibung | +| --------------------- | ----- | -------- | -------------------------------------------------------- | +| `--payload-dir ` | `-p` | ✅ | Verzeichnis mit allen zu verteilenden Dateien | +| `--entrypoint ` | `-e` | ✅ | Ausführbare Datei *innerhalb* von **DIR** | +| `--output ` | `-o` | ❌ | Zielpfad der erzeugten `.run`-Datei (Default: `sfx.run`) | --- @@ -115,12 +117,11 @@ Die Platzhalter werden beim Build automatisch ersetzt. ## Troubleshooting -| Problem | Ursache / Lösung | -|---------------------------------------|-------------------------------------------------------------------| -| `zstd: command not found` | Installiere das Paket `zstd`. | -| Entrypoint wird nicht ausgeführt | Prüfe Ausführungsrechte (`chmod +x`). | -| „Marker __ARCHIVE_BEGIN__ not found“ | Stelle sicher, dass der Header unverändert ist. | -| `bad tar header` bei Ausführung | Header im Repo vs. Build-Header gemischt? `make clean && make`. | +| Problem | Ursache / Lösung | +| ------------------------------------ | ----------------------------------------------- | +| `zstd: command not found` | Installiere das Paket `zstd`. | +| Entrypoint wird nicht ausgeführt | Prüfe Ausführungsrechte (`chmod +x`). | +| „Marker __ARCHIVE_BEGIN__ not found“ | Stelle sicher, dass der Header unverändert ist. | ---