maxp/bash-sfx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): update structure and tables for improved clarity

Browse Source
This commit is contained in:
0xMax42
2025-06-15 16:35:28 +02:00
parent fd0c2a8f84
commit 5c928e565a
1 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -9,14 +9,16 @@ externe Abhängigkeiten verteilen möchtest.
## Inhalt ## Inhalt
1. [Funktionsweise](#funktionsweise) - [Self-Extracting Archive (SFX) Builder](#self-extracting-archive-sfx-builder)
2. [Voraussetzungen](#voraussetzungen) - [Inhalt](#inhalt)
3. [Schnellstart](#schnellstart) - [Funktionsweise](#funktionsweise)
4. [Beispiele](#beispiele) - [Voraussetzungen](#voraussetzungen)
5. [Erklärung der Parameter](#erklärung-der-parameter) - [Schnellstart](#schnellstart)
6. [Dateiaufbau des SFX](#dateiaufbau-des-sfx) - [Beispiele](#beispiele)
7. [Troubleshooting](#troubleshooting) - [Erklärung der Parameter](#erklärung-der-parameter)
8. [Lizenz](#lizenz) - [Dateiaufbau des SFX](#dateiaufbau-des-sfx)
- [Troubleshooting](#troubleshooting)
- [Lizenz](#lizenz)
--- ---
@@ -38,13 +40,13 @@ externe Abhängigkeiten verteilen möchtest.
## Voraussetzungen ## Voraussetzungen
| Tool | Zweck | Getestete Version | | Tool | Zweck | Getestete Version |
|-----------------|----------------------------|-------------------| | ---------------------------------------- | ------------------------- | ----------------- |
| `bash` | Shell-Interpreter | ≥ 4.2 | | `bash` | Shell-Interpreter | ≥ 4.2 |
| `tar` | Paketierung | _(coreutils)_ | | `tar` | Paketierung | _(coreutils)_ |
| `zstd` | Kompression | ≥ 1.5 | | `zstd` | Kompression | ≥ 1.5 |
| `numfmt` | Menschliche Größenangaben | _(coreutils)_ | | `numfmt` | Menschliche Größenangaben | _(coreutils)_ |
| GNU `sed`, `grep`, `cut`, `wc`, `mktemp` | Hilfs-Tools | _(coreutils)_ | | GNU `sed`, `grep`, `cut`, `wc`, `mktemp` | Hilfs-Tools | _(coreutils)_ |
> **Tipp:** Unter Debian/Ubuntu genügt: > **Tipp:** Unter Debian/Ubuntu genügt:
> `sudo apt install zstd coreutils` > `sudo apt install zstd coreutils`
@@ -89,11 +91,11 @@ bash -x cool_tool.run --version
## Erklärung der Parameter ## Erklärung der Parameter
| Option | Alias | Pflicht? | Beschreibung | | Option | Alias | Pflicht? | Beschreibung |
|----------------------------|-------|----------|--------------------------------------------------| | --------------------- | ----- | -------- | -------------------------------------------------------- |
| `--payload-dir <DIR>` | `-p` | ✅ | Verzeichnis mit allen zu verteilenden Dateien | | `--payload-dir <DIR>` | `-p` | ✅ | Verzeichnis mit allen zu verteilenden Dateien |
| `--entrypoint <FILE>` | `-e` | ✅ | Ausführbare Datei *innerhalb* von **DIR** | | `--entrypoint <FILE>` | `-e` | ✅ | Ausführbare Datei *innerhalb* von **DIR** |
| `--output <FILE>` | `-o` | ❌ | Zielpfad der erzeugten `.run`-Datei (Default: `sfx.run`) | | `--output <FILE>` | `-o` | ❌ | Zielpfad der erzeugten `.run`-Datei (Default: `sfx.run`) |
--- ---
@@ -115,12 +117,11 @@ Die Platzhalter werden beim Build automatisch ersetzt.
## Troubleshooting ## Troubleshooting
| Problem | Ursache / Lösung | | Problem | Ursache / Lösung |
|---------------------------------------|-------------------------------------------------------------------| | ------------------------------------ | ----------------------------------------------- |
| `zstd: command not found` | Installiere das Paket `zstd`. | | `zstd: command not found` | Installiere das Paket `zstd`. |
| Entrypoint wird nicht ausgeführt | Prüfe Ausführungsrechte (`chmod +x`). | | Entrypoint wird nicht ausgeführt | Prüfe Ausführungsrechte (`chmod +x`). |
| „Marker __ARCHIVE_BEGIN__ not found“ | Stelle sicher, dass der Header unverändert ist. | | „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`. |
--- ---