ntu/index.md

35 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2025-03-20 02:46:27 +01:00
# Willkommen bei meinem Projekt
NameToUnix - Rust Command line tool for cleaning up directory & file names according to Linux conventions. Replacing offending characters or spaces (recursive with `-r` flag).
2025-03-20 02:46:27 +01:00
Dieses Projekt bietet unter Linux eine einfache Lösung für das automatische Umbenennen von Verzeichnissen und Dateien nach dem Entpacken von gezippten Windows-Dateien mit Leerzeichen oder Sonderzeichen im Namen.
## Zielsetzung
Das Ziel ist es, diese unkonventionellen Dateinamen automatisch sinnvoll umzubenennen. Ab v1.0.0 ist die rekursive Verarbeitung opt-in (`-r` Flag erforderlich).
2025-03-20 02:46:27 +01:00
## Inhaltsverzeichnis
2025-03-20 02:51:25 +01:00
```text
2025-03-18 03:05:18 +01:00
NameToUnix/
├── .github/ # CI/CD und GitHub-spezifische Dateien
│ └── workflows/
2025-03-20 02:46:27 +01:00
│ └── build.yaml # GitHub Actions Workflow für Build and Release
2025-03-20 03:03:14 +01:00
├── test/ # enthält test-Verzeichnis Skript
│ └── create_test_tree.sh # Bash-Skript erzeugt ein skurriles Testverzeichnis
2025-03-18 03:05:18 +01:00
├── src/ # Quellcode-Verzeichnis
│ ├── main.rs # Haupteinstiegspunkt (bereits vorhanden)
│ ├── cli.rs # CLI-Argumente und Parsing
│ ├── config.rs # Konfigurationsverwaltung
│ └── sanitizer.rs # Kernlogik zur Dateinamenbereinigung
2025-03-20 03:03:14 +01:00
├── .NameToUnix.conf # Konfigurationsdatei (Übersetzungsregeln: 'foo' = 'bar')
├── CONTRIBUTING.md # Contribute-Dokumentation
2025-03-20 03:20:34 +01:00
├── Cargo.lock # Abhängigkeiten
2025-03-20 03:03:14 +01:00
├── Cargo.toml # Projektmetadaten und Abhängigkeiten
├── LICENSE # Lizenzinformationen
├── README.md # Projektdokumentation
2025-03-20 02:49:23 +01:00
├── index.md # diese Datei (german)
2025-03-20 03:03:14 +01:00
└── release.md # Infos über dieses Release (german)
2025-03-20 02:51:25 +01:00
```
2025-03-18 03:05:18 +01:00
2025-03-20 02:46:27 +01:00
## Hinweise zur Nutzung
Um dieses Projekt zu nutzen, folge bitte den Anweisungen in der [README -Datei](README.md).