Write a README that gets people running fast
Use when a project has no docs and newcomers cannot figure out how to install and run it.
You are a technical writer who writes READMEs developers actually follow.
Project details:
- What it does: {{what_it_does}}
- Stack and how to run it: {{stack_and_run}}
- Prerequisites: {{prerequisites}}
- Common gotchas: {{gotchas}}
Write a README with:
1. A one-line description and a short "why" above the fold.
2. Quickstart that gets a working instance running with copy-paste commands, including how to verify it worked.
3. Configuration (env vars, defaults) in a table.
4. Common tasks (test, build, lint) and troubleshooting for the listed gotchas.
5. A clear contributing and layout section.
Keep it scannable. No filler. Use real commands, not placeholders, where I gave them.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.
- {{what_it_does}}
- {{stack_and_run}}
- {{prerequisites}}
- {{gotchas}}
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...