Aktualisierte README.md

README.md

@@ -1,4 +1,10 @@
-# Dateinamen-Reparatur-Tool "NameToUnix"
+# Filename Repair Tool 
+# "NameToUnix"
+
+A powerful command line tool for cleaning up file names according to Linux conventions.
+It works under Linux (and should also work under MacOS, but I have not tested it there). 
+The program is useful if many file names, e.g. after downloading and unpacking zip files from Windows file systems 
+contain spaces or special characters. It saves an enormous amount of time by automatically replacing the offending characters. 
 
 Ein leistungsstarkes Kommandozeilen-Tool zum Bereinigen von Dateinamen gemäß Linux-Konventionen.
 Es funktioniert unter Linux (und sollte auch unter MacOS laufen, dort habe ich es aber nicht getestet). 
@@ -7,7 +13,14 @@ Leerzeichen oder Sonderzeichen enthalten. Es erspart enorm viel Zeit durch autom
 
 (c) 2025 Dieter Schlüter <dieter.schlueter@linix.de>
 
-## Funktionen
+## Functions / Funktionen
+
+- Replaces spaces and special characters in file and directory names with underscores
+- Converts German umlauts to their ASCII counterparts (ä → ae, etc.)
+- Supports recursive processing of directories
+- Provides preview mode without actual changes
+- Allows user-defined replacement rules via configuration file
+- Supports exclusion patterns for specific file patterns/directory patterns
 
 - Ersetzt Leerzeichen und Sonderzeichen in Datei- und Verzeichnisnamen durch Unterstriche
 - Konvertiert deutsche Umlaute in ihre ASCII-Pendants (ä → ae, usw.)
@@ -32,8 +45,32 @@ cd NameToUnix
 cargo build --release
 ```
 
-Die ausführbare Datei wird dann unter `target/release/NameToUnix` erstellt.
+Die ausführbare Datei wird dann unter `target/release/NameToUnix` erstellt. Du solltest sie mit 'sudo cp target/release/NameToUnix /usr/local/bin/' kopieren. Sie ist dann für alle User verfügbar. Denke daran, die Konfiguationsdatei (s. u.) ebenfalls zu kopieren. Sie kann für jeden User individuell angepasst werden, wenn sie im home-Verzeichnis des Users liegt.
 
+The executable file is then created under `target/release/NameToUnix`. You should copy it with 'sudo cp target/release/NameToUnix /usr/local/bin/'. It is then available for all users. Remember to copy the configuration file (see below) as well. It can be customized for each user individually if it is located in the user's home directory.
+
+## Usage
+
+```bash
+# Basic usage
+NameToUnix /path/to/files
+
+# Only preview the changes without actual renaming
+NameToUnix -n /path/to/files
+
+# Process multiple paths
+NameToUnix /path1 /path2 /path3
+
+# Exclude specific files
+NameToUnix -e “*.tmp” -e “backup_*” /path/to/files
+
+# Increase verbosity
+NameToUnix -v /path/to/files
+
+# Also rename the root directory
+NameToUnix --modify-root /path/to/files
+
+```
 ## Verwendung
 
 ```bash
@@ -56,11 +93,14 @@ NameToUnix -v /pfad/zu/dateien
 NameToUnix --modify-root /pfad/zu/dateien
 ```
 
-## Konfiguration
+## Configuration File / Konfiguration
 
 Erstelle eine Datei `.NameToUnix.conf` im Arbeitsverzeichnis z. B. mit folgendem Inhalt 
 (alternativ `~/.config/NameToUnix/config.toml`):
 
+Create a file `.NameToUnix.conf` in the working directory, e.g. with the following content 
+(alternatively `~/.config/NameToUnix/config.toml`):
+
 ```toml
 [replacements]
 "foo" = "bar"
@@ -76,6 +116,7 @@ Erstelle eine Datei `.NameToUnix.conf` im Arbeitsverzeichnis z. B. mit folgendem
 "ü" = "ue"
 "ß" = "ss"
 ```
+Du kannst Die Datei nach Belieben anpassen. You can customize the file as you wish.
 
 ### Verwendung von NameToUnix
 
@@ -107,6 +148,28 @@ Options:
 
 ```
 
+### Usage of NameToUnix
+
+```text
+A tool for adapting directories and file names to Linux conventions
+
+Usage: NameToUnix [OPTIONS] [PATHS]...
+
+Arguments:
+[PATHS]... Paths (files and directories) for recursive customization
+
+Options:
+-q, --quiet Suppress output (no renaming info on stdout)
+-n, --no-changes Only display, but do not make any real changes
+-f, --force Overwrite existing files
+-e, --exclude <PATTERN> Patterns to be ignored (-e “*.py”, several can be specified)
+-v, --verbose Detailed debug information
+    --modify-root Allows you to customize the root directory as well
+-h, --help Print help
+-V, --version Print version
+
+```
+
 ## Test
 
 Im Verzeichnis [***./test***](./test) gibt es ein bash-Skript [***create_test_tree.sh***](test/create_test_tree.sh), das lokal 21 Test-Verzeichnisse und 400 Dateien mit skurrilen Zufallsnamen erzeugt. Damit kannst Du ***NameToUnix*** ausprobieren:
@@ -115,11 +178,22 @@ Im Verzeichnis [***./test***](./test) gibt es ein bash-Skript [***create_test_tr
 oder
 ***NameToUnix ./testverzeichnis*** (Anzeige mit Umbenennen).
 
-## Lizenz
+
+In the directory [***./test***](./test) there is a bash script [***create_test_tree.sh***](test/create_test_tree.sh), which locally creates 21 test directories and 400 files with bizarre random names. You can use this to try out ***NameToUnix***:
+ 
+***NameToUnix -n ./testverzeichnis*** (display changes only)
+or
+***NameToUnix ./testverzeichnis*** (display with renaming).
+
+## Lizenz / License
+
+This project is licensed under the MIT license - see the [LICENSE](LICENSE) file for details.
 
 Dieses Projekt steht unter der MIT-Lizenz - siehe die [LICENSE](LICENSE)-Datei für Details.
 
-## Mitwirken
+## Mitwirken / Contributions
+
+Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the pull request process.
 
 Beiträge sind willkommen! Bitte lies [CONTRIBUTING.md](CONTRIBUTING.md) für Details zum Prozess für Pull Requests.