textWritingintermediate
README.md for an open-source repo
Scaffold installs, philosophy, contrib, screenshots placeholder, roadmap.
Suggested model: Claude Opus 4.7Estimated length: 450 tokens
Customize this template
Build your prompt
Generate Your Prompt
Fill in the required details first. Optional controls help you fine-tune the result.
See a completed example
Draft
Input Variables
repo_name:skillgraph-mcp-gateway
pitch:Type-safe MCP tool registry snapshots for CI reviewers
stack:TypeScript · Node 20 · Vitest · Prisma optional
primary_user:platform engineers onboarding internal agents
license:Apache-2.0
install_story:pnpm
Questions about this prompt
Best Practices
Critical Best Practices
Lead with role and scope
criticalSay who you are, who the reader is, and what artifact you want in one dense block.
Source: claude
Recommended Best Practices
Spell out constraints
recommendedLength, tone bans, jargon limits, formatting, and what not to hallucinate.
Source: claude
Related Templates
Keywords
readme promptgithub readme aiopen source readme generator