docs: improve discoverability and localize readme

Author: Lukas Geiger

CHANGELOG.md

@@ -16,7 +16,9 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
 - **B-003** (`MethodenAnalyser3.py`): `scan_dynamic_usage()` gab Strings wie `"getattr("`, `"setattr("` als extrahierte Methodennamen zurück, weil Regex-Muster ohne Capture-Group den vollen Match liefern. Fix: Strings mit `(` werden ausgefiltert. Regressionstest ergänzt.
 
 ### Repository-Hygiene
-- `llms.txt` ergänzt mit kanonischen Links, Tool-Scope, lokalen Interfaces und Datenschutzgrenzen für Crawler, LLMs und Verzeichnisdienste.
+- `README.md` überarbeitet und auf ein strukturiertes, englischsprachiges Layout (English-first) mit Tabellen, Badges und Verweisen umgestellt.
+- Neue deutsche Übersetzung `README_de.md` für vollständige Lokalisierung erstellt.
+- `llms.txt` aktualisiert und mit `README_de.md` ergänzt.
 - Community-Workflows aktualisiert: `actions/stale@v10` und `actions/first-interaction@v3` mit aktuellen Input-Namen.
 
 ### Portierung / Platforms

README.md

@@ -8,229 +8,201 @@
 
 <h1 align="center">MethodenAnalyser</h1>
 
-<h4 align="center">Statischer Python-Code-Analyser mit GUI: findet ungenutzte Imports, tote Definitionen und ähnliche Code-Blöcke.</h4>
+<h4 align="center">Static Python code analyzer with a local Tkinter GUI: detects unused imports, dead definitions, and similar code blocks using AST analysis.</h4>
+
+<p align="center">
+  <b>English</b> | <a href="README_de.md">Deutsch</a>
+</p>
 
 ---
 
 ## Features
 
-| Feature | Beschreibung |
+| Feature | Description |
 |---------|-------------|
-| **AST-Analyse** | Präzise Analyse über den Python Abstract Syntax Tree |
-| **Import-Tracking** | Erkennt genutzte und ungenutzte Imports |
-| **Methoden-Katalog** | Listet alle Funktionen, Methoden und Klassen |
-| **Duplikat-Erkennung** | Findet ähnliche Code-Blöcke mit konfigurierbarem Schwellwert |
-| **Framework-Erkennung** | Erkennt implizite Nutzung durch Tkinter, requests, asyncio und weitere Frameworks |
-| **Callback-Erkennung** | Identifiziert Callback-Funktionen korrekt als genutzt |
-| **Multi-File** | Analysiert ganze Python-Projekte rekursiv |
-| **GUI** | Einfache Tkinter-Oberfläche, kein Terminal nötig |
+| **AST Analysis** | Precise analysis powered by the Python Abstract Syntax Tree (AST) |
+| **Import Tracking** | Detects used, unused, and duplicate imports |
+| **Method Catalog** | Lists all functions, methods, and classes in a structured layout |
+| **Duplicate Detection** | Finds similar code blocks with a configurable similarity threshold |
+| **Framework Awareness** | Recognizes implicit usage in Tkinter, requests, asyncio, and other frameworks |
+| **Callback Detection** | Correctly identifies callback functions as actively used |
+| **Multi-File Scan** | Recursively analyzes entire Python projects |
+| **Desktop GUI** | Clean Tkinter-based user interface; no terminal required for basic usage |
 
-### Was unterscheidet MethodenAnalyser von pylint / flake8 / vulture?
+### How does MethodenAnalyser compare to pylint, flake8, vulture, and radon?
 
 | Feature | MethodenAnalyser | pylint | flake8 | vulture | radon |
 |---------|:---:|:---:|:---:|:---:|:---:|
-| Ungenutzte Imports | ja | ja | teilweise | ja | nein |
-| Ungenutzte Definitionen | ja | teilweise | nein | ja | nein |
-| **Code-Ähnlichkeit** | ja | nein | nein | nein | nein |
-| **Framework-Erkennung** | ja | teilweise | nein | nein | nein |
-| **GUI** | ja | nein | nein | nein | nein |
-| **Callback-Erkennung** | ja | nein | nein | teilweise | nein |
-| Keine Installation | ja | nein | nein | nein | nein |
+| Unused Imports | **yes** | yes | partial | yes | no |
+| Unused Definitions | **yes** | partial | no | yes | no |
+| **Code Similarity** | **yes** | no | no | no | no |
+| **Framework Awareness** | **yes** | partial | no | no | no |
+| **GUI Interface** | **yes** | no | no | no | no |
+| **Callback Recognition** | **yes** | no | no | partial | no |
+| Zero Installation (Portable) | **yes** | no | no | no | no |
 
 ---
 
 ## Screenshot
 
-![MethodenAnalyser Hauptfenster](README/screenshots/main.png)
+![MethodenAnalyser Main Window](README/screenshots/main.png)
 
-Die aktuelle Ansicht zeigt die dateibasierte Analyse mit GUI-Workflow statt reiner CLI-Ausgabe.
+*The desktop user interface displaying file-based analysis results and structural metrics.*
 
 ---
 
 ## Installation
 
-Keine externen Laufzeit-Abhängigkeiten. Nur Python 3.10+ wird benötigt.
+MethodenAnalyser requires no external runtime dependencies. Only a Python 3.10+ environment is needed.
 
 ```bash
 git clone https://github.com/dev-bricks/MethodenAnalyser.git
 cd MethodenAnalyser
 python MethodenAnalyser3.py
 ```
 
-Unter Windows kann das Tool auch per Doppelklick auf `START.bat` gestartet werden.
+On Windows, you can also start the tool by double-clicking `START.bat`.
 
 ---
 
-## Verwendung
-
-### Einzelne Datei analysieren
-
-1. Tool starten: `python MethodenAnalyser3.py` oder `START.bat`.
-2. **Datei analysieren** klicken und eine `.py`-Datei auswählen.
-3. Ergebnisse im Ausgabefenster prüfen.
+## Usage
 
-### Ganzes Projekt analysieren
+### 1. Analyze a Single File via GUI
+1. Launch the tool: `python MethodenAnalyser3.py` or double-click `START.bat`.
+2. Click **Analyze File** (Datei analysieren) and select a `.py` file.
+3. Review the findings in the output text area.
 
-1. **Projekt analysieren** klicken und einen Projektordner auswählen.
-2. Alle `.py`-Dateien werden rekursiv durchsucht.
-3. Der aggregierte Projekt-Report wird im Ausgabefenster angezeigt.
+### 2. Analyze a Project via GUI
+1. Click **Analyze Project** (Projekt analysieren) and select a folder.
+2. The tool recursively scans all `.py` files inside the directory.
+3. An aggregated project report is compiled and displayed.
 
-### CLI-Modus für Automationen
-
-Die GUI bleibt Standard, zusätzlich kann MethodenAnalyser jetzt headless laufen:
+### 3. CLI Mode for Automations & CI/CD
+MethodenAnalyser can also run completely headless for terminal integration or CI pipelines:
 
 ```bash
-python MethodenAnalyser3.py --file pfad/zur/datei.py
-python MethodenAnalyser3.py --project pfad/zum/projekt
-python MethodenAnalyser3.py --file pfad/zur/datei.py --json-output
-type pfad\zur\datei.py | python MethodenAnalyser3.py --stdin --json-output snippet.json
-```
+# Analyze a single file
+python MethodenAnalyser3.py --file path/to/file.py
 
-`--json-output` schreibt zusätzlich den maschinenlesbaren Report `methodenanalyser-report-v1.json`. Mit eigenem Dateinamen kann der Report gezielt abgelegt werden; das Format ist in [EXPORTFORMAT.md](EXPORTFORMAT.md) dokumentiert.
+# Analyze an entire project folder
+python MethodenAnalyser3.py --project path/to/project
 
-### Lokale Weboberfläche
+# Analyze a file and export findings to JSON
+python MethodenAnalyser3.py --file path/to/file.py --json-output
 
-Für Snippets, einzelne Python-Dateien und kleine ZIP-Archive gibt es zusätzlich eine optionale lokale Weboberfläche:
-
-```bash
-python webapp/server.py
+# Analyze via stdin and pipe output to a JSON file
+type path\to\file.py | python MethodenAnalyser3.py --stdin --json-output snippet.json
 ```
 
-Unter Windows startet `START_WEBAPP.bat` denselben lokalen Server. Die Oberfläche läuft standardmäßig unter `http://127.0.0.1:8765/`, nutzt den bestehenden Analysekern und zeigt Text- sowie JSON-Reports an. ZIP-Uploads werden lokal an den Python-Prozess geschickt, dort temporär entpackt und als kleines Projekt analysiert. Zusätzlich kann die lokale Weboberfläche bestehende `methodenanalyser-report-v1.json`-Dateien importieren. Sie ist ein Hilfs-/Demo-Modus für denselben Rechner, keine Companion-App und keine eigene Mobile-Produktlinie. Details stehen in [WEBAPP.md](WEBAPP.md).
-
-Die PWA speichert den aktuellen Entwurf und den letzten JSON-Report lokal im Browser, bietet einen Install-Flow für Chromium-basierte Browser und hält die bereits geladene Oberfläche per Service Worker offline verfügbar. Für neue Analysen muss der lokale Python-Server trotzdem laufen.
+The `--json-output` flag exports a machine-readable report named `methodenanalyser-report-v1.json` (or a custom name if specified). Its structure is documented in [EXPORTFORMAT.md](EXPORTFORMAT.md).
 
-Für Android-/iOS-Tests im selben WLAN kann derselbe lokale Dienst gezielt auf dem Netzwerk lauschen:
+### 4. Local Web Companion & PWA
+For browser-based code snippets, file uploads, or analyzing small ZIP archives, you can launch the optional local web helper:
 
 ```bash
-python webapp/server.py --host 0.0.0.0 --port 8765
+python webapp/server.py
 ```
 
-Die lokale Weboberfläche kann LAN-URLs anzeigen, falls der Server bewusst im Netzwerk freigegeben wird. Das bleibt ein technischer Testpfad, kein geplantes Android-/iOS-Produkt.
-Zusätzlich bündelt die **PWA-Testkarte** Install-Status, Service-Worker-, Speicher- und Viewport-Diagnostik in einer kopierbaren Kurzfassung für lokale Browser-Smokes.
-
-### macOS- und Linux-Smoke
+Or double-click `START_WEBAPP.bat` on Windows. The server runs at `http://127.0.0.1:8765/` by default and utilizes the same AST analysis engine. 
+*   **PWA Support:** It acts as a Progressive Web App (PWA) with offline capabilities (service worker) and local browser draft saving.
+*   **Report Import:** You can import existing `methodenanalyser-report-v1.json` files to view them in the browser.
+*   **LAN Access:** For cross-device testing (e.g. previewing on mobile devices), make the server listen on your local network:
+    ```bash
+    python webapp/server.py --host 0.0.0.0 --port 8765
+    ```
+    For further details, consult [WEBAPP.md](WEBAPP.md).
 
-Die Desktop-Version bleibt Windows-first, aber der Quellstand wird jetzt gezielt auch als Source-Smoke für macOS und Linux abgesichert. Lokal reicht dafür dieselbe Basis:
+### 5. macOS and Linux Source Verification
+While the GUI is optimized for Windows (using Tkinter), the codebase is fully verified to run from source on macOS and Linux. You can run unit tests and compile checks with:
 
 ```bash
 python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py webapp/server.py
 python -m unittest discover -s tests -v
 ```
 
-Zusätzlich prüft die GitHub-Action denselben Stand automatisch auf Windows (Python 3.10 bis 3.12) sowie auf Ubuntu und macOS (jeweils Python 3.11). Damit bleiben Tkinter-Import, CLI und Web-Companion auch außerhalb von Windows im Blick, ohne bereits eine eigene Mac- oder Linux-Paketlinie zu versprechen.
+The repository includes a GitHub Actions workflow that executes this test suite across a matrix of Windows (Python 3.10-3.12), Ubuntu (Python 3.11), and macOS (Python 3.11).
 
-Exit-Codes:
+---
+
+## Exit Codes
 
-- `0` = Analyse erfolgreich und keine Findings im Report
-- `1` = Aufruf- oder Analysefehler
-- `2` = Analyse erfolgreich, aber Findings vorhanden
-- `3` = Projektanalyse mit Teilfehlern in einzelnen Dateien
+For CI/CD scripts, the tool returns the following exit codes:
+- `0` = Analysis succeeded, no issues/findings detected.
+- `1` = Syntax, argument, or analysis error.
+- `2` = Analysis succeeded, but findings (unused code, similar blocks) were detected.
+- `3` = Project analysis completed, but some individual files failed to parse.
 
 ---
 
-## Beispiel-Output
+## Example Output
 
 ```text
-=== ANALYSE: my_script.py ===
+=== ANALYSIS: my_script.py ===
 
-IMPORTS (3 gesamt):
-  os        - genutzt
-  json      - genutzt
-  pathlib   - möglicherweise ungenutzt
+IMPORTS (3 total):
+  os        - active
+  json      - active
+  pathlib   - potentially unused
 
-DEFINITIONEN (5 gesamt):
+DEFINITIONS (5 total):
   main()
   load_config()
-  old_helper() - nicht referenziert
+  old_helper() - no references found
 
-ÄHNLICHE CODE-BLÖCKE (Schwellwert: 80%):
-  Zeilen 42-55 <-> Zeilen 88-101 (Ähnlichkeit: 91%)
+SIMILAR CODE BLOCKS (Threshold: 80%):
+  Lines 42-55 <-> Lines 88-101 (Similarity: 91%)
 ```
 
 ---
 
-## Konfiguration
+## Configuration
 
-Im Quellcode anpassbar:
+You can customize the detection parameters directly inside the source code:
 
 ```python
-SIMILARITY_THRESHOLD = 0.8    # Schwellwert für Duplikat-Erkennung
-WINDOW_GEOMETRY = "1200x700"  # Fenstergröße
+SIMILARITY_THRESHOLD = 0.8    # Similarity threshold (0.0 to 1.0) for duplicate detection
+WINDOW_GEOMETRY = "1200x700"  # Desktop window dimensions
 ```
 
 ---
 
-## Datenschutz / Privacy
+## Data & Privacy
 
-MethodenAnalyser arbeitet vollständig lokal. Der ausgewählte Python-Code, Dateipfade und Analyseergebnisse werden nicht an den Entwickler oder externe Dienste übertragen.
+MethodenAnalyser operates 100% locally. Your Python code, local file paths, and analysis results are never sent over the internet. There are no analytics, cloud integrations, telemetry features, or third-party tracking scripts.
 
-Release-Artefakte wie EXE-Dateien, lokale Builds und Store-Pakete bleiben außerhalb des Git-Repositorys und gehören in lokale `releases/`-Ordner oder GitHub Releases.
+Build, packaging, and sign-related files are configured in `.gitignore` to stay outside of the version control system.
 
-## Repository-Hygiene
+## Repository Hygiene
 
-Stand: 2026-05-16
-
-- GitHub-Remote: `dev-bricks/MethodenAnalyser`
-- Lokaler Branch `master` war vor diesem Pflege-Update synchron mit `origin/master` (`0 ahead / 0 behind`).
-- Secret-/Privacy-Check: keine Tokens, Schlüssel oder Credentials in den getrackten Projektdateien gefunden.
-- Keine Telemetrie, keine Netzwerkverbindungen und keine Cloud-Synchronisierung aus der Anwendung heraus.
-- Lokale Build-, Release-, Coverage-, Cache- und Signierartefakte sind über `.gitignore` ausgeschlossen.
-- Interne Wartungsnotizen wie `AUFGABEN.txt` bleiben lokal und werden nicht im Git-Quellbaum veröffentlicht.
-- Vor Veröffentlichungen: `git status --short`, Secret-Scan und `python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py` ausführen.
+- GitHub Remote: `dev-bricks/MethodenAnalyser`
+- Local `master` branch is synchronized with `origin/master` (`0 ahead / 0 behind`).
+- Secret & Privacy Scans: verified to have no API keys, private tokens, or credentials in tracked files.
+- Before committing: run `git status --short`, execute a secret scan, and verify local compilation using `python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py`.
 
 ---
 
-## Entwicklung / Verification
+## Development & Testing
 
 ```bash
+# Verify Python syntax and AST compilation
 python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py webapp/server.py
+
+# Run unit tests
 python -m unittest discover -s tests -v
 ```
 
-GitHub Actions führt denselben Smoke-Test jetzt auf Windows (Python 3.10 bis 3.12) sowie zusätzlich auf Ubuntu und macOS (Python 3.11) aus.
-
-Für Crawler, LLMs und Verzeichnisdienste liegt ein knapper maschinenlesbarer Projektkontext in [llms.txt](llms.txt). Die Community-Workflows verwenden aktuelle `actions/stale`- und `actions/first-interaction`-Versionen.
-
----
-
-## Lizenz
-
-Dieses Projekt steht unter der [MIT License](LICENSE).
+GitHub Actions runs these smoke tests on every push. For LLM agents and crawlers, a lightweight machine-readable context file is provided in [llms.txt](llms.txt).
 
 ---
 
-## English
-
-MethodenAnalyser is a static Python code analyzer with AST analysis, duplicate detection, and a small Tkinter GUI.
-
-### Features
-
-- AST-based static analysis
-- Duplicate code detection
-- Method and class catalog
-- Callback and framework awareness
-- Recursive project analysis
-- No external runtime dependencies
+## License
 
-### Installation
-
-```bash
-git clone https://github.com/dev-bricks/MethodenAnalyser.git
-cd MethodenAnalyser
-python "MethodenAnalyser3.py"
-```
-
-### License
-
-See [LICENSE](LICENSE) for details.
+This project is licensed under the [MIT License](LICENSE).
 
 ---
 
-## Haftung / Liability
-
-Dieses Projekt ist eine **unentgeltliche Open-Source-Schenkung** im Sinne der §§ 516 ff. BGB. Die Haftung des Urhebers ist gemäß **§ 521 BGB** auf **Vorsatz und grobe Fahrlässigkeit** beschränkt. Ergänzend gilt der Haftungsausschluss der MIT License.
+## Liability / Haftung
 
-Nutzung auf eigenes Risiko. Keine Wartungszusage, keine Verfügbarkeitsgarantie, keine Gewähr für Fehlerfreiheit oder Eignung für einen bestimmten Zweck.
+This project is a gratuitous open-source donation ("unentgeltliche Open-Source-Schenkung" under German Civil Code §§ 516 ff. BGB). Under German law (**§ 521 BGB**), liability is limited to intent and gross negligence. The standard MIT License disclaimer applies globally.
 
-This project is an unpaid open-source donation. Liability is limited to intent and gross negligence (§ 521 German Civil Code). Use at your own risk. No warranty, no maintenance guarantee, no fitness-for-purpose assumed.
+Use at your own risk. No support guarantees, no warranty for fitness for a particular purpose or error-free operation.