Task prompt · Coding
Write a README for my project
by Agent Yard TeamA README people actually read: what, why, how to run.
You'll attach
Text only
Works with
Cursor
Claude Code
Codex
Claude
ChatGPT
GeminiUse cases
- A README people actually read: what, why, how to run.
- Reuse it as often as you like: fill in the blanks (project notes) with new details and copy again.
- With Cursor, Claude Code, Codex and more, the AIs that support what this prompt needs.
Featured in: Best Claude prompts for essays and writing.
How to use it
- Open Cursor or Claude Code in your terminal (or another AI listed here).
- Fill in the highlighted blank ([PROJECT NOTES]) below, or edit them after pasting.
- Copy the prompt, paste it into the chat and send.
Fill in the blanks (optional)
Prompt
Write a README.md for this project. Read the code (or use my notes: [PROJECT NOTES]). Sections: one-line description, what problem it solves, screenshot placeholder, quick start (copy-paste commands), configuration, common tasks, how to contribute, license. Keep it short. Only document commands and options that actually exist in the code.
One email a week
The Weekly is presented byyour brandSponsored · openThe best new prompts and personas, nothing else.