Initialize narratio Go module and CLI scaffold
This commit is contained in:
29
README.md
29
README.md
@@ -1,3 +1,30 @@
|
||||
# narratio
|
||||
|
||||
Narratio is a pipeline orchestration tool that turns D&D session audio into useful artifacts like transcripts, campaign logs, and analysis.
|
||||
`narratio` is a Go-based orchestration application for processing D&D session audio into transcripts and downstream artifacts.
|
||||
|
||||
This repository is currently an **initial scaffold** that establishes:
|
||||
|
||||
- Go module and package boundaries
|
||||
- Placeholder CLI commands: `run`, `plan`, `status`, `resume`, `run-stage`
|
||||
- Basic structured logging setup via `log/slog`
|
||||
- Stub adapter, stage, config, manifest, artifact, and contract packages
|
||||
|
||||
## Current State
|
||||
|
||||
The CLI commands are intentionally placeholders and print `not yet implemented` messages.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
go run ./cmd/narratio plan
|
||||
```
|
||||
|
||||
## Non-Goals (Current Pass)
|
||||
|
||||
This scaffold does not yet implement:
|
||||
|
||||
- real config loading/validation behavior
|
||||
- manifest persistence behavior
|
||||
- stage execution behavior
|
||||
- real WhisperX/seriatim/audita/analyzer integrations
|
||||
- real S3 or notification integrations
|
||||
|
||||
Reference in New Issue
Block a user