docs: refresh project documentation
This commit is contained in:
20
README.md
20
README.md
@@ -2,9 +2,27 @@
|
||||
|
||||
Standalone Go application for BMC diagnostics analysis with an embedded web UI.
|
||||
|
||||
## What it does
|
||||
|
||||
- Parses vendor diagnostic archives into a normalized hardware inventory
|
||||
- Collects live BMC data via Redfish
|
||||
- Exports normalized data as CSV, raw re-analysis bundles, and Reanimator JSON
|
||||
- Runs as a single Go binary with embedded UI assets
|
||||
|
||||
## Documentation
|
||||
|
||||
- Architecture and technical documentation (single source of truth): [`docs/bible/README.md`](docs/bible/README.md)
|
||||
- Shared engineering rules: [`bible/README.md`](bible/README.md)
|
||||
- Project architecture and API contracts: [`bible-local/README.md`](bible-local/README.md)
|
||||
- Agent entrypoints: [`AGENTS.md`](AGENTS.md), [`CLAUDE.md`](CLAUDE.md)
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
make build
|
||||
./bin/logpile
|
||||
```
|
||||
|
||||
Default port: `8082`
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user