Skip to content

Commit 5bb0ec2

Browse files
author
Osman Γ–demis
committed
docs(domain.md): update documentation to english
1 parent fb99f97 commit 5bb0ec2

File tree

2 files changed

+126
-132
lines changed

2 files changed

+126
-132
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 58 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
# GitSynth πŸš€
22

3-
rm -rf .venv
4-
poetry env use python3.11
5-
6-
Ein intelligentes CLI-Tool fΓΌr automatisierte Git-Commits, Dokumentation und Changelog-Management mit LLM-UnterstΓΌtzung.
3+
An intelligent CLI tool for automated Git commits, documentation, and changelog management with LLM support.
74

85
## Features 🎯
96

107
### Smart Commit Messages
11-
- Automatische Erkennung von Commit-Typen basierend auf https://www.conventionalcommits.org/en/v1.0.0/
12-
- Kontextbewusste Commit-Beschreibungen
13-
- Git-History-basierte VorschlΓ€ge
8+
- Automatic detection of commit types based on https://www.conventionalcommits.org/en/v1.0.0/
9+
- Context-aware commit descriptions
10+
- Git history-based suggestions
1411

15-
### Changelog-Management
16-
- Automatische CHANGELOG.md Generierung
17-
- Kategorisierte Γ„nderungen
18-
- VerknΓΌpfung mit Commits
12+
### Changelog Management
13+
- Automatic CHANGELOG.md generation
14+
- Categorized changes
15+
- Commit linking
1916

2017
## Tech Stack πŸ› 
2118

2219
### Core
23-
- LangChain: LLM Integration und Tools
24-
- LangGraph: Agenten-Orchestrierung
25-
- Ollama: Lokales LLM (Mistral oder Llama2)
26-
- Chroma: Vektorstore fΓΌr Embeddings
20+
- LangChain: LLM Integration and Tools
21+
- LangGraph: Agent Orchestration
22+
- Ollama: Local LLM (Mistral or Llama2)
23+
- Chroma: Vector store for Embeddings
2724
- HuggingFace Embeddings (BAAI/bge-small-en-v1.5)
2825

2926
### Development
@@ -33,116 +30,115 @@ Ein intelligentes CLI-Tool fΓΌr automatisierte Git-Commits, Dokumentation und Ch
3330
- Rich: Terminal Formatting
3431

3532
## Quick Start πŸƒβ€β™‚οΈ
36-
Das Skirpt core/commit_agent.py ist der Kern.
37-
Leider hat tools mit Ollama nicht funktioniert, es ist also ein Chain.
38-
FΓΌr eine detaillierte Beschreibung , siehe [Domain Documentation](docs/domain.md).
33+
34+
The core/commit_agent.py script is the heart of the application.
35+
Unfortunately, tools with Ollama didn't work, so it's a Chain.
36+
For a detailed description, see [Domain Documentation](docs/domain.md).
3937

4038
## Installation
4139

42-
### Voraussetzungen
40+
### Prerequisites
4341
- Python 3.11+
4442
- Poetry
4543
- Git
46-
- Ollama (fΓΌr lokales LLM)
44+
- Ollama (for local LLM)
4745

48-
### Entwicklungs-Setup
46+
### Development Setup
4947

50-
1. **Repository klonen**:
48+
1. **Clone repository**:
5149
```bash
5250
git clone https://github.com/yourusername/gitsynth.git
5351
cd gitsynth
5452
```
5553

56-
2. **Python-Version setzen**:
54+
2. **Set Python version**:
5755
```bash
58-
# Wenn du Conda verwendest, erst deaktivieren
56+
# If using Conda, deactivate first
5957
conda deactivate
6058

61-
# Python 3.11 fΓΌr Poetry setzen
59+
# Set Python 3.11 for Poetry
6260
poetry env use python3.11
6361
```
6462

65-
3. **Dependencies installieren**:
63+
3. **Install dependencies**:
6664
```bash
6765
poetry install
6866
```
6967

70-
4. **Entwicklungsumgebung aktivieren**:
68+
4. **Activate development environment**:
7169
```bash
7270
poetry shell
7371
```
74-
5. **Beliebiege Repo wechseln und Γ€nderungen stagen**:
72+
73+
5. **Switch to any repo and stage changes**:
7574
```bash
7675
git init
77-
git add .
76+
git add .
7877
```
7978

80-
6. **Gitsynth starten**:
79+
6. **Start Gitsynth**:
8180
```bash
8281
gitsynth agent commit
8382
```
8483

84+
### Usage
8585

86-
### Verwendung
87-
88-
Nach der Aktivierung der Poetry-Shell:
86+
After activating the Poetry shell:
8987

9088
```bash
91-
# Commit erstellen mit Changelog
89+
# Create commit with changelog
9290
gitsynth agent commit
9391

94-
# Γ„nderungen analysieren
92+
# Analyze changes
9593
gitsynth analyze
9694

97-
# Debuggen analysieren
98-
gitsynth debug oder gitsynth agent commit --debug
95+
# Debug analysis
96+
gitsynth debug or gitsynth agent commit --debug
9997

100-
# TODO: Hilfe anzeigen
98+
# TODO: Show help
10199
gitsynth --help
102100
```
103101

104102
## Features
105103

106-
- πŸ€– KI-gestΓΌtzte Commit-Analyse
107-
- πŸ“ Intelligente Commit-Messages
108-
- 🎯 Conventional Commits Support
109-
- 🎨 Schâne Terminal-Ausgaben
110-
104+
- πŸ€– AI-powered commit analysis
105+
- πŸ“ Intelligent commit messages
106+
- 🎯 Conventional Commits support
107+
- 🎨 Beautiful terminal output
111108

112109
## Troubleshooting
113110

114-
- **"Command not found: poetry"**: Poetry neu installieren oder PATH setzen
115-
- **Conda Konflikte**: `conda deactivate` vor Poetry-Nutzung
116-
- **Ollama-Fehler**: Sicherstellen dass Ollama lΓ€uft (`ollama run llama2`)
117-
118-
## Architektur πŸ—
111+
- **"Command not found: poetry"**: Reinstall Poetry or set PATH
112+
- **Conda conflicts**: Run `conda deactivate` before using Poetry
113+
- **Ollama errors**: Ensure Ollama is running (`ollama run llama3.2`)
119114

120-
### Agenten
121-
1. **CommitAgent**: Analysiert Changes & generiert Commits
115+
## Architecture πŸ—
122116

117+
### Agents
118+
1. **CommitAgent**: Analyzes changes & generates commits
123119

124-
## πŸ“‹ Verwendung
120+
## πŸ“‹ Usage
125121

126122
```bash
127-
# Siehe den Flow
123+
# See the flow
128124
gitsynth agent commit
129125
```
130126

131127
## Roadmap πŸ—Ί
132128

133-
- [βœ…] Basic CLI Setup mit Poetry & Typer
134-
- [βœ…] Git Integration & Diff-Analyse
135-
- [βœ… ❌] LangChain/LangGraph Agent-System
136-
- [βœ… ] Chroma Vector Store Integration
137-
- [βœ… ] Ollama LLM Integration
138-
- [βœ… ] Erste Commit-Message-Generation
139-
- [βœ… ] Dokumentations-Synchronisation
140-
- [ ❌] Changelog-Management
129+
- [βœ…] Basic CLI Setup with Poetry & Typer
130+
- [βœ…] Git Integration & Diff Analysis
131+
- [βœ… ❌] LangChain/LangGraph Agent System
132+
- [βœ…] Chroma Vector Store Integration
133+
- [βœ…] Ollama LLM Integration
134+
- [βœ…] Initial Commit Message Generation
135+
- [βœ…] Documentation Synchronization
136+
- [❌] Changelog Management
141137

142138
## Contributing 🀝
143139

144-
BeitrΓ€ge sind willkommen!
140+
Contributions are welcome!
145141

146-
## Lizenz πŸ“„
142+
## License πŸ“„
147143

148144
MIT

0 commit comments

Comments
Β (0)