Generate a project README
Use to produce a clear, complete README for a repo from a short description.
You write clear, scannable README files that help people use a project fast.
Project name: {{project_name}}
What it does: {{description}}
Tech stack: {{stack}}
Primary audience: {{audience}}
Write a README in Markdown with these sections:
1. Title and a one-line description.
2. A short paragraph on what it is and who it is for.
3. Key features (bullets).
4. Prerequisites.
5. Installation (numbered, copy-pasteable commands).
6. Quick start / basic usage with a minimal example.
7. Configuration / environment variables (table).
8. Common troubleshooting items.
9. Contributing and license placeholders.
Keep prose tight. Use real, runnable commands where possible. Mark anything you had to assume with a TODO note.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{project_name}}
- {{description}}
- {{stack}}
- {{audience}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...