pi_coder/examples/README.md

74 lines
2.2 KiB
Markdown
Raw Normal View History

# pi-coder Beispielprojekte
Vier kleine, eigenständige Projekte als Demonstrationsgrundlage für die pi-coder-Features.
Jedes Projekt startet bewusst unvollständig — genau der Ausgangspunkt, für den pi-coder gebaut ist.
## Übersicht
| Verzeichnis | Sprache | Demonstriert |
|---|---|---|
| `python-calculator/` | Python | `/optimize` mit `--test-cmd pytest` |
| `rust-wordcount/` | Rust | `/optimize` mit `--test-cmd "cargo test"` + `/version` |
| `go-fibonacci/` | Go | `/optimize --interactive` + `/continue` + `/shipit` |
| `c-linkedlist/` | C | `/quick_check` + `/fix` + `/patch` |
## Demo-Workflow
### Schritt 1 — Vorbereitung: Sub-Repos anlegen
Jedes Example braucht ein eigenes git-Repo, damit pi-coder commit-basierte
Features nutzen kann (Loop-Erkennung, Diff-Anzeige, `/version`):
```bash
for dir in python-calculator rust-wordcount go-fibonacci c-linkedlist; do
cd examples/$dir
git init && git add -A && git commit -m "feat: initial $dir"
cd ../..
done
```
Für `/version` im rust-wordcount-Beispiel zusätzlich:
```bash
cd examples/rust-wordcount && git tag v0.1.0
```
### Schritt 2 — Demo ausführen
In pi das jeweilige Unterverzeichnis als Arbeitsverzeichnis öffnen.
Die genauen Befehle stehen im README.md des jeweiligen Examples.
Zeitmessung: Systemuhr notieren oder Terminal-Kommando `time` nutzen.
### Schritt 3 — Protokoll ausfüllen
Jedes Example enthält eine `PROTOKOLL.md`.
Startzeit, Endzeit, Rundenanzahl und Endergebnis eintragen.
### Schritt 4 — Ausgangszustand wiederherstellen
```bash
bash examples/restore-all.sh
```
Das Skript löscht Sub-Repos, restauriert alle Quelldateien aus dem Haupt-Repo
und bereinigt Build-Artefakte (`target/`, `__pycache__` etc.).
---
## Empfohlene Demo-Reihenfolge
| # | Beispiel | Geschätzte Dauer | Highlights |
|---|---|---|---|
| 1 | `python-calculator` | ~510 min | Einstieg, Test-Loop |
| 2 | `c-linkedlist` | ~5 min | `/quick_check` + `/fix`, kein Loop |
| 3 | `rust-wordcount` | ~1015 min | Loop + `/version` |
| 4 | `go-fibonacci` | ~1520 min | `--interactive` + `/shipit` |
---
## Weitere Details
[python-calculator](python-calculator/README.md) ·
[rust-wordcount](rust-wordcount/README.md) ·
[go-fibonacci](go-fibonacci/README.md) ·
[c-linkedlist](c-linkedlist/README.md)