0votes
README that people actually readTemplateLow risk
A clear README for any project in the right order.
Write a README for {{project_name}}: {{project_description}}. Order: 1. One-line description and who it's for. 2. Screenshot or demo placeholder. 3. Quick start (copy-paste commands, under 5 steps). 4. Configuration (table: name, required, default, description). 5. Common tasks / usage examples. 6. How it works (short, optional diagram). 7. Contributing and license. Use short sections and code blocks. Assume the reader has 2 minutes.

Log in to join the discussion.