README.md erweitert: GUI- und CLI-Version dokumentiert
- Beide Versionen (GUI und CLI) klar vorgestellt - GUI-Features und Drag & Drop hervorgehoben - Verwendungsanleitung für beide Versionen - Projektstruktur und technische Details ergänzt - Links zu weiteren Dokumentationen hinzugefügt
This commit is contained in:
102
README.md
102
README.md
@@ -2,6 +2,36 @@
|
||||
|
||||
Dieses Tool extrahiert Kalenderdaten aus Dienstplan-PDFs und konvertiert sie in das iCalendar-Format (ICS), das von den meisten Kalenderanwendungen importiert werden kann.
|
||||
|
||||
## 🎯 Zwei Versionen verfügbar
|
||||
|
||||
### 1. **GUI-Version** (Grafische Oberfläche) - Empfohlen!
|
||||
Benutzerfreundliche grafische Oberfläche mit Drag & Drop Support.
|
||||
|
||||
```bash
|
||||
./start_gui.sh
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- ✨ Drag & Drop für PDF-Dateien
|
||||
- 📋 Mehrere PDFs gleichzeitig verarbeiten
|
||||
- 📁 Ausgabe-Verzeichnis frei wählbar
|
||||
- 📊 Live-Log und Fortschrittsanzeige
|
||||
- 💾 Merkt sich letzte Verzeichnisse
|
||||
|
||||
**Voraussetzung:** Tkinter muss installiert sein (siehe [GUI_README.md](GUI_README.md))
|
||||
|
||||
### 2. **CLI-Version** (Kommandozeile)
|
||||
Textbasiertes Menü für die Kommandozeile.
|
||||
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- ⚡ Funktioniert überall ohne zusätzliche Abhängigkeiten
|
||||
- 🔄 Automatische Verarbeitung aller PDFs im Verzeichnis
|
||||
- 📝 Textbasiertes interaktives Menü
|
||||
|
||||
## Features
|
||||
|
||||
✅ Extrahiert Dienstplan-Informationen aus PDFs
|
||||
@@ -9,9 +39,54 @@ Dieses Tool extrahiert Kalenderdaten aus Dienstplan-PDFs und konvertiert sie in
|
||||
✅ Handhabt Nachtschichten korrekt (über Mitternacht hinaus)
|
||||
✅ Erstellt Standard-konforme ICS-Dateien
|
||||
✅ Unterstützt mehrere PDFs gleichzeitig
|
||||
✅ Benutzerfreundliche Oberfläche
|
||||
✅ GUI mit Drag & Drop (optional)
|
||||
✅ CLI-Menü für schnelle Nutzung
|
||||
|
||||
## Installation
|
||||
### Schnellstart (Empfohlen)
|
||||
|
||||
**Für GUI-Version:**
|
||||
```bash
|
||||
./start_gui.sh
|
||||
```
|
||||
Siehe [GUI_README.md](GUI_README.md) für Tkinter-Installation.
|
||||
|
||||
**Für CLI-Version:**
|
||||
```bash
|
||||
./start.sh
|
||||
```GUI-Version (Empfohlen)
|
||||
|
||||
1. Starten Sie die GUI:
|
||||
```bash
|
||||
./start_gui.sh
|
||||
```
|
||||
|
||||
2. Fügen Sie PDF-Dateien hinzu:
|
||||
- Klicken Sie auf "➕ PDF hinzufügen", oder
|
||||
- Ziehen Sie PDF-Dateien in die Liste (Drag & Drop)
|
||||
|
||||
**Interaktives Menü:**
|
||||
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
|
||||
Dann wählen Sie im Menü die gewünschte Option.
|
||||
|
||||
### Erweiterte Nutzung (Python-Modul)abe-Verzeichnis (optional)
|
||||
|
||||
4. Klicken Sie auf "📄 ICS Datei erstellen"
|
||||
|
||||
Die GUI merkt sich Ihre letzten Verzeichnisse für schnelleren Zugriff!
|
||||
|
||||
### CLI-Version
|
||||
|
||||
**Schnellstart:**
|
||||
|
||||
Beide Skripte erstellen automatisch eine Python Virtual Environment und installieren alle benötigten Abhängigkeiten.
|
||||
|
||||
### Manuelle Installation
|
||||
|
||||
|
||||
Die erforderlichen Dependencies sind bereits installiert. Falls Sie das Projekt neu einrichten:
|
||||
|
||||
@@ -101,10 +176,35 @@ Die ICS-Datei enthält ein Event für jeden Arbeitstag mit:
|
||||
|
||||
## Technische Details
|
||||
|
||||
### Projektstruktur
|
||||
|
||||
```
|
||||
ICS-Import/
|
||||
├── pdf_to_ics.py # Core-Konvertierungslogik
|
||||
├── gui.py # GUI-Version (Tkinter)
|
||||
├── menu.py # CLI-Menü
|
||||
├── start_gui.sh/cmd # GUI-Startskripte
|
||||
├── start.sh/cmd # CLI-Startskripte
|
||||
├── README.md # Diese Datei
|
||||
└── GUI_README.md # GUI-spezifische Dokumentation
|
||||
```
|
||||
|
||||
### Technische Spezifikationen
|
||||
|
||||
- **Abhängigkeiten**: pdfplumber, icalendar, pytz, pypdf2
|
||||
- **Optional für GUI**: tkinter (Python-Standard), tkinterdnd2 (Drag & Drop)
|
||||
- **Python-Version**: 3.6+
|
||||
- **Format**: iCalendar 2.0 (RFC 5545)
|
||||
- **Konfiguration**: `~/.pdf_to_ics_config.json` (GUI-Einstellungen)
|
||||
|
||||
## Lizenz
|
||||
|
||||
Dieses Tool ist zur privaten Verwendung gedacht.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Weitere Dokumentation
|
||||
|
||||
- **[GUI_README.md](GUI_README.md)** - Ausführliche GUI-Dokumentation und Tkinter-Installation
|
||||
- **[QUICKSTART.md](QUICKSTART.md)** - Schnellanleitung für den Import in verschiedene Kalender
|
||||
- **[ZUSAMMENFASSUNG.md](ZUSAMMENFASSUNG.md)** - Projekt-Übersicht und technische Details
|
||||
|
||||
Reference in New Issue
Block a user