Software Development

README Best Practices

Structure, tone, and content conventions for writing effective project README files, covering hooks, quick starts, feature presentation, badges, and common documentation sections. Use when writing a new README, rewriting an existing one, or reviewing README quality for a repository, library, or CLI tool.

Publisher / source
Mindrally/skills (found on skills.sh)
Upstream record
Mindrally/skills
Version
Version 3
Published
Publication review
Approved for publication
Content fingerprint
defc65eacaeb720640c6346d96697045421ff6b1987f308166936268cd7757bc