Write a README for your project

This prompt writes a README for your project. You give the name, what it does, the tech stack, how to install and run it and the main features, and it includes a short pitch, features and a quick start.

text-readme-generator — chatgpt — 46 words

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.

Edit in the builder Copy & open ChatGPT ↗Copy & open Gemini ↗Copy & open Claude ↗

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

Get a better result

What you will get

A clear README with a short pitch, a features list, a quick start, a usage example, configuration, contributing and licence sections, and code blocks for every command.

Why it works

Most visitors decide in a few seconds whether a project is for them, so the pitch and quick start come first. The install and run steps you give become copyable commands, which is what people use most. Scannable sections help both newcomers and returning users find what they need without reading everything.

Common mistake

The quick start skips a step.

Fix: Follow it on a clean machine or a new folder, and paste the step that failed back in.

Also watch for

It invents a licence or badges. Tell it the licence you actually chose and ask it not to add badges for services you do not use.
The pitch is vague, like “a powerful tool”. Ask for one sentence saying who it is for and what they can do with it in a minute.

Try a variation: write a contributing guide

Ask for a separate CONTRIBUTING file covering how to set up, run tests, name branches and open a pull request.

Still not right? Reply with this

Add a short section near the top describing a screenshot or GIF I should record, and what it must show.