Better Readme
This commit is contained in:
parent
e7be1c94fd
commit
ddd3975042
46
README.me
46
README.me
@ -20,7 +20,7 @@ Die Anwendung kombiniert einen agentischen Workflow mit einer Reflexions-Engine,
|
||||
|
||||
# Projektstruktur
|
||||
|
||||
```text
|
||||
```
|
||||
main.py
|
||||
|
||||
src/
|
||||
@ -43,7 +43,7 @@ src/
|
||||
|
||||
# Architektur
|
||||
|
||||
## `main.py`
|
||||
## main.py
|
||||
|
||||
Der Einstiegspunkt der Anwendung.
|
||||
|
||||
@ -62,7 +62,7 @@ Enthält die gesamte Kernlogik der Anwendung.
|
||||
|
||||
---
|
||||
|
||||
## `chat_manager.py`
|
||||
## chat_manager.py
|
||||
|
||||
Zentrale Steuerungseinheit des Assistenten.
|
||||
|
||||
@ -79,7 +79,7 @@ Der `ChatManager` bildet das Herzstück der Anwendung.
|
||||
|
||||
---
|
||||
|
||||
## `reflection_engine.py`
|
||||
## reflection_engine.py
|
||||
|
||||
Implementiert den selbstreflektierenden Agenten-Workflow.
|
||||
|
||||
@ -94,18 +94,18 @@ Funktionen:
|
||||
|
||||
---
|
||||
|
||||
## `execution_engine.py`
|
||||
## execution_engine.py
|
||||
|
||||
Verantwortlich für:
|
||||
|
||||
* Ausführen von Dateien
|
||||
* Ausführen von Code-Snippets
|
||||
* Erfassen von `stdout` und `stderr`
|
||||
* Erfassen von stdout und stderr
|
||||
* Rückgabe von Debug-Logs
|
||||
|
||||
---
|
||||
|
||||
## `file_manager.py`
|
||||
## file_manager.py
|
||||
|
||||
Verwaltet:
|
||||
|
||||
@ -115,27 +115,27 @@ Verwaltet:
|
||||
|
||||
---
|
||||
|
||||
## `tools.py`
|
||||
## tools.py
|
||||
|
||||
Definiert verfügbare Tools und das Tool-Registry-System.
|
||||
|
||||
Beispiele:
|
||||
|
||||
* `read_file`
|
||||
* `edit_file`
|
||||
* `execute_file`
|
||||
* `execute_code`
|
||||
* `search`
|
||||
* read_file
|
||||
* edit_file
|
||||
* execute_file
|
||||
* execute_code
|
||||
* search
|
||||
|
||||
---
|
||||
|
||||
## `llm_client.py`
|
||||
## llm_client.py
|
||||
|
||||
Kommunikation mit dem verwendeten LLM/API.
|
||||
|
||||
---
|
||||
|
||||
## `system_prompter.py`
|
||||
## system_prompter.py
|
||||
|
||||
Erstellt dynamische Systemprompts inklusive:
|
||||
|
||||
@ -175,7 +175,7 @@ Ablauf:
|
||||
|
||||
## Reflection Workflow
|
||||
|
||||
```text
|
||||
```
|
||||
Benutzeranfrage
|
||||
↓
|
||||
Erste Antwort
|
||||
@ -281,7 +281,7 @@ streamlit run main.py
|
||||
|
||||
## Code erklären
|
||||
|
||||
```text
|
||||
```
|
||||
Was macht diese Funktion?
|
||||
```
|
||||
|
||||
@ -289,7 +289,7 @@ Was macht diese Funktion?
|
||||
|
||||
## Datei bearbeiten
|
||||
|
||||
```text
|
||||
```
|
||||
Füge Kommentare zu dieser Datei hinzu
|
||||
```
|
||||
|
||||
@ -297,7 +297,7 @@ Füge Kommentare zu dieser Datei hinzu
|
||||
|
||||
## Datei ausführen
|
||||
|
||||
```text
|
||||
```
|
||||
Führe die aktuelle Datei aus
|
||||
```
|
||||
|
||||
@ -305,10 +305,6 @@ Führe die aktuelle Datei aus
|
||||
|
||||
## Fehler analysieren
|
||||
|
||||
```text
|
||||
Warum tritt dieser Fehler auf?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
Warum tritt dieser Fehler auf?
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user