readme-improvement

Use readme-improvement to generate a complete README.md with project overview, installation steps, getting started guide, and setup instructions. The Skill creates a structured, user-focused document that resolves missing or inconsistent project documentation across software projects.

A comprehensive README covers installation guides, getting started steps, project overview, and setup instructions with clear formatting and examples. This Skill generates all sections with consistent structure and user-first language to help new users understand and configure your project.

Yes, readme-improvement enhances existing README.md files by ensuring consistent formatting, complete installation steps, and clear getting started guides. It validates documentation accuracy and restructures content for better clarity and user experience.

The Skill applies a standardized README structure with explicit validation and anti-hallucination protocols to generate accurate, consistent documentation. It uses evidence-chain validation to ensure installation guides and setup instructions match actual project requirements.

readme-improvement generates a markdown README.md with standardized sections for project overview, installation, getting started, and setup instructions. The structure follows multi-phase workflows with explicit to-do lists and external memory-driven analysis for accuracy.