c/writing › command
0votes

README that people actually readTemplateLow risk

submitted by u/client to c/writing · 0 copies

A clear README for any project in the right order.

Template · 2 variables
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.
0 commentsreport
Sponsored
0 comments

Log in to join the discussion.