DevTools Logo
PromptMIT

README Writer

A prompt for turning an existing project structure and usage notes into a concise, maintainable README.

View source Source Reviewed

Prompt template

Write a README for the project described below. Preserve facts, call out unknowns instead of inventing them, and include setup, scripts, configuration, and troubleshooting sections.

Project notes:
{{PROJECT_NOTES}}

Input and output

Input: Plain text project notes or a sanitized repository summary.

Output: Markdown README with factual sections and runnable commands.

Examples

Input: A TypeScript CLI with `pnpm install`, `pnpm build`, and `pnpm test`.

Output: A README with prerequisites, installation, command reference, configuration, and test instructions.

Security notes

Do not include private environment variables, credentials, or internal URLs in the input.