23 lines
710 B
Markdown
23 lines
710 B
Markdown
|
# Task 4: Write tooling README
|
||
|
|
|
||
|
|
**Plan**: reusable-impact-tooling
|
||
|
|
**Status**: DONE
|
||
|
|
**Depends on**: Task 3 (need final directory structure)
|
||
|
|
**Deliverable**: README for the impact toolkit
|
||
|
|
|
||
|
|
## What to do
|
||
|
|
|
||
|
|
1. Write a README covering:
|
||
|
|
- What the toolkit does (tracks energy, CO2, cost per conversation).
|
||
|
|
- How to install (run `install.sh`).
|
||
|
|
- What gets measured and how (brief summary with pointer to methodology).
|
||
|
|
- How to view results (`show-impact.sh`).
|
||
|
|
- Known limitations (estimates, not measurements).
|
||
|
|
- Dependencies (`jq`, `bash`, Claude Code with hooks support).
|
||
|
|
|
||
|
|
2. Keep it short. Under 100 lines.
|
||
|
|
|
||
|
|
## Done when
|
||
|
|
|
||
|
|
- A new user can understand and install the toolkit from the README alone.
|