Write a README From Your Code and Notes Without Invented Commands
You get a complete README with requirements, install, usage and config sections built only from your pasted code, plus a list of gaps to fill.
Prompt
You are a senior developer who writes clear, accurate READMEs for open-source and internal projects.
Your job: write a README for my project. First, ask me these questions in one numbered message, and ask me to paste my code, config files and notes with my answers. Then wait.
1. Who will read this README (end users, contributors or teammates), and how experienced are they?
2. Which OS, language version and package manager does the project target?
3. Is there anything the README must not claim, such as stability, license or support?
Rules:
- Every install, run and config command must come from my pasted material. If a needed command is missing, write "GAP:" and state what is missing. Do not guess.
- Each config option gets its name, default value and a one-line purpose, all taken from the code.
- Show expected output in Usage only if it appears in my material. Otherwise mark it as a gap.
- Use short sentences. No marketing language, and no badges or links you cannot verify.
Output format:
1. Project name and one-sentence description
2. Requirements
3. Installation (numbered steps with code blocks)
4. Usage (examples with code blocks)
5. Configuration (table: Option | Default | Description | Source file)
6. Gaps to fill (bulleted list)
End with one line listing any assumptions you made about the audience or environment.Example output
Tips and common edits
Why this works
- Asking about audience and environment first sets the right detail level for install steps.
- Limiting commands to pasted material and marking GAPs stops the model from inventing install or run steps.
- The config table with a source file column lets you check every option against the code.
Use this in ChatGPT, Claude or Gemini when a project has no README or an outdated one. Have your main script, dependency file, config or .env example and any rough notes ready to paste.
Common edits
- Add a Contributing section with branch, test and pull request steps for open-source projects.
- Ask for a shorter quick-start version to put at the top of the README.
Prompt details
- By
- Prompts-GPT editors
- Published
Did this prompt work?
Keep exploring
More like this
Add Docstrings and Why-Focused Comments to Your Pasted Code
Returns your code with standard-style docstrings covering parameters, return values and raised errors, plus comments that explain intent rather than restate the code.
Explain a Confusing Coding Tutorial or Docs Passage in Plain English
Paste a confusing passage from a programming tutorial or docs and get a plain-English rewrite, inline jargon definitions, a tiny runnable example and a list of what to learn first.
Architecture Decision Record for a Technology Choice
Compares realistic options against your constraints and produces a decision record. The record has a weighted comparison, risks, a reversal plan, and a recommendation the team can approve or challenge.
Combine and Clean Multiple CSV or Excel Files into One Table with Power Query
You get a header mapping table, numbered Power Query clicks, commented M code that fixes mismatched columns and duplicates, and refresh steps for new files.
Write a Google Apps Script to Automate a Repetitive Google Sheets Task
You get a commented Google Apps Script built around your sheet names, columns and timing, plus install steps, a test plan on a copy, and undo steps.
Write an Excel VBA Macro That Cleans and Formats Your Recurring Report
You get a commented VBA macro built from your own column headers, with backup steps, install instructions and a post-run checklist.