Draft a README for my project
Drafts a README with purpose, setup, usage and contribution notes from the project details I give, marking every step I must test myself.
Task:
Draft a README for my project.
Context:
The project is [project name], which [what it does in one sentence]. It is written in [language and framework] and runs on [platforms]. The readers are [target readers]. The install and run commands are [install and run commands].
Rules:
- Use the sections, in this order, What it is, Requirements, Install, Usage, Configuration, Contributing.
- Use only the commands I gave. Add a line "untested" above any step you had to infer, so I know to run it.
- Show configuration as a table of option, meaning and default, using placeholders for any value I did not give.
- If a command in the install steps deletes or overwrites files, explain what it does in the line before it.
Result:
The README in Markdown, at most 400 words, with code blocks for commands.