From 6d4baad203f8e9f279fcb2e1e337c70c2746740f Mon Sep 17 00:00:00 2001
From: Thorsten <thorsten.seine@gmail.com>
Date: Mon, 6 Jan 2025 21:13:39 +0100
Subject: [PATCH] readme

---
 README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8d1be0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# Convert Comics Script
+
+Dieses Skript ermöglicht die Umwandlung von Comic-Dateien zwischen den Formaten **CBR** und **CBZ**. Nach erfolgreicher Konvertierung wird die Originaldatei automatisch gelöscht.
+
+## Features
+
+- **CBR zu CBZ:** Konvertiert `.cbr`-Dateien in `.cbz`.
+- **CBZ zu CBR:** Konvertiert `.cbz`-Dateien in `.cbr`.
+- **Automatisches Löschen:** Die Originaldatei wird nach erfolgreicher Konvertierung entfernt.
+- **Batch-Verarbeitung:** Verarbeitet alle Dateien in einem angegebenen Verzeichnis.
+
+## Voraussetzungen
+
+Das Skript benötigt folgende Programme:
+
+    `unrar`: Zum Entpacken von `.cbr`-Dateien.
+    `rar`: Zum Erstellen von `.cbr`-Dateien.
+    `zip`: Zum Erstellen von `.cbz`-Dateien.
+    `unzip`: Zum Entpacken von `.cbz`-Dateien.
+
+## Installation der benötigten Programme
+
+Unter Linux können die benötigten Tools mit den folgenden Befehlen installiert werden:
+**Debian/Ubuntu:**
+```bash
+sudo apt update
+sudo apt install unrar rar zip unzip
+```
+**Fedora:**
+```bash
+sudo dnf install unrar rar zip unzip
+```
+**Arch Linux:**
+```bash
+sudo pacman -S unrar rar zip unzip
+```
+
+## Installation
+
+1. Speichere das Skript als `convert_comics.sh`.
+2. Script ausführbar machen:
+**Arch Linux:**
+```bash
+chmod +x convert_comics.sh
+```
+
+## Verwendung
+Das Skript benötigt zwei Parameter: den Modus ('cbz' oder 'cbr') und den Pfad zu einem Verzeichnis, das die Dateien enthält.
+
+## Beispiel 1: CBR zu CBZ konvertieren
+```bash
+./convert_comics.sh cbz /pfad/zum/verzeichnis
+```
+- Konvertiert alle '.cbr'-Dateien im angegebenen Verzeichnis in '.cbz'.
+- Die Original-'.cbr'-Dateien werden gelöscht.
+
+## Beispiel 2: CBZ zu CBR konvertieren
+```bash
+./convert_comics.sh cbr /pfad/zum/verzeichnis
+```
+- Konvertiert alle '.cbz'-Dateien im angegebenen Verzeichnis in '.cbr'.
+- Die Original-'.cbz'-Dateien werden gelöscht.
+
+## Hinweis
+
+- Die Konvertierung ist **verlustfrei**, da nur die enthaltenen Bilddateien verarbeitet werden.
+- Es werden keine zusätzlichen Metadaten in den Dateien gespeichert.
\ No newline at end of file