Establish initial Go application skeleton
This commit is contained in:
20
README.md
20
README.md
@@ -1,2 +1,22 @@
|
||||
# weatherreporter
|
||||
|
||||
`weatherreporter` is a Go application for preparing human-facing weather
|
||||
reports from normalized forecast data.
|
||||
|
||||
The repository currently contains the application skeleton and a minimal CLI
|
||||
help command. Report generation, configuration loading, weather API fetching,
|
||||
and `scriptorium` rendering are tracked in the roadmap and are not implemented
|
||||
yet.
|
||||
|
||||
## Quickstart
|
||||
|
||||
```sh
|
||||
weatherreporter --help
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [CLI reference](docs/cli.md)
|
||||
- [Architecture policy](docs/policy/architecture.md)
|
||||
- [Development policy](docs/policy/development.md)
|
||||
- [Implementation roadmap](docs/roadmap/initial.md)
|
||||
|
||||
Reference in New Issue
Block a user