Home › Agent workflows › Create README prompt file (Copilot)

Create README prompt file (Copilot)

A Copilot prompt file (/create-readme) that writes or updates a README from the actual repo contents and verified commands.

GitHub CopilotAgent workflows

Copy create-readme.prompt.md

How to use

Save this as .github/prompts/create-readme.prompt.md in your repository root, commit it, and your agent will pick it up automatically. Edit the commands to match your project.

Note: Review and test before use. Provided as is, without warranty. See Terms.

---
description: Write or update the README from the actual repository contents
agent: agent
---

Create or update `README.md` for this repository.

1. Explore first: package manifests (`package.json`, `pyproject.toml`, `go.mod`, `Cargo.toml`), scripts/Makefile, CI workflows, `.env.example`, Docker files, and the main entry points. Base everything on what exists; don't invent features.
2. Structure:
   - Project name and a one-paragraph description of what it does and for whom.
   - **Quick start:** prerequisites (with versions from the manifests), install, configure env (table of variables from `.env.example`), run.
   - **Common tasks:** test, lint, build, deploy commands exactly as defined in scripts.
   - **Project structure:** a short tree of top-level folders with one line each.
   - **Contributing** and **License** (link existing files).
3. Commands go in fenced `bash` blocks, one per line, copy-pasteable.
4. If a README exists, keep accurate sections and the author's tone; fix outdated commands and fill gaps.
5. Run the install/test commands if feasible to confirm they work, and say which ones you verified.

Don't include secrets, internal URLs, or badges for services the repo doesn't use.