Text & chat prompt

Write a README for your project

Write a README for your project: a free, copy-paste prompt for ChatGPT, Gemini and Claude. Paste the prompt and replace each [BRACKETED] field with your own details.

The prompt

Write a README.md for my project.

Name: [NAME]
What it does: [DESCRIPTION]
Tech stack: [TECH]
How to install and run: [STEPS]
Main features: [LIST]

Include a short pitch, features, quick start, usage example, configuration, contributing and licence sections. Clear and scannable, with code blocks for commands.

Pro tip: Add a screenshot or GIF. It gets more stars than a longer README.

How to use this prompt

  1. Open ChatGPT and start a new chat.
  2. Paste the prompt.
  3. Replace each [BRACKETED] field with your real details and paste in your own text where asked.
  4. Reply with follow-ups such as "make it shorter" or "make it sound more like me".

Prompt at a glance

Category
Text & chat
Works with
ChatGPT · Gemini · Claude
Length
46 words
Fields to fill in
NAME, DESCRIPTION, TECH, STEPS, LIST
Last updated

Frequently asked questions

Which AI tools work with this prompt?

It is written for ChatGPT, Gemini and Claude. Paste it into your preferred tool and adjust the wording if the result is off.

What do I need to fill in?

Replace these fields before you send it: NAME, DESCRIPTION, TECH, STEPS, LIST. Each field shows an example in the prompt.

Should I paste private information into the prompt?

Only what the task needs. Remove names, contact details and other sensitive data before pasting a resume or document into any AI tool.

More chat & writing prompts

See all 373 chat & writing prompts →