README Polish
Purpose
Improve a README for clarity and completeness.
Inputs to request
- •Current README content.
- •Setup prerequisites and runtime versions.
- •Common failure modes or FAQs.
Workflow
- •Ensure install, run, and test steps are present and ordered.
- •Add required environment variables and configuration notes.
- •Clarify expected outputs and common troubleshooting tips.
Output
- •Revised README section suggestions.
- •Checklist of missing items.
Quality bar
- •Keep instructions concise and copy-pasteable.
- •Surface the most common pitfalls early.