Skip to content

Commit 4205fd2

Browse files
f3rdyclaude
andcommitted
Document AI usage-prompt command and pre-commit workflow in README
Added: - Installation step for pre-commit hooks (make hooks) - New section explaining AI usage-prompt command - Usage examples (terminal, plain, save to file) - Note about pre-commit hook validation This helps developers understand how to: 1. Generate AI usage guides for assistants 2. Keep documentation in sync with code changes 3. Use pre-commit hooks for validation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 508d19f commit 4205fd2

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ pip install git+https://github.com/cdds-ab/workshopforge.git
5050
git clone https://github.com/cdds-ab/workshopforge.git
5151
cd workshopforge
5252
make install
53+
make hooks # Installiert pre-commit hooks
5354
```
5455

5556
### Voraussetzungen
@@ -401,6 +402,23 @@ Verhindert defekte Specs im Repository.
401402
- **[Project Summary](PROJECT_SUMMARY.md)** - Architektur-Übersicht
402403
- **[Features](FEATURES.md)** - Feature-Liste und Roadmap
403404
405+
### AI Usage Guide Command
406+
407+
Für AI-Assistenten steht ein spezielles Command zur Verfügung:
408+
409+
```bash
410+
# Im Terminal anzeigen (formatiert)
411+
workshopforge ai usage-prompt
412+
413+
# Als Plain Markdown ausgeben (für .claude/ai-usage-prompt.md)
414+
workshopforge ai usage-prompt --plain
415+
416+
# Direkt in Datei speichern
417+
workshopforge ai usage-prompt --plain > .claude/ai-usage-prompt.md
418+
```
419+
420+
Die Guide wird automatisch aus `AI_USAGE_GUIDE.md` geladen. Bei Code-Änderungen (CLI, Provider, Policies) prüft ein Pre-commit Hook, ob die Dokumentation aktualisiert werden muss.
421+
404422
## FAQ
405423

406424
**Q: Kann ich generierte Dateien manuell editieren?**

0 commit comments

Comments
 (0)