Template

README Template

A clear README.md for any software project, with the sections developers look for first, ready to download as Markdown and drop into your repository.

Updated November 19, 2026In Web & DevelopmentFree download: Markdown, Word, PDF

Download this template free

No sign-up needed. Word and Excel files also open in Google Docs, Google Sheets and Apple Pages/Numbers. Letter size (8.5 × 11 in).

[Project Name]

[One-sentence description of what the project does and who it is for.]

[Badges: build status · version · license]

Features

  • [Key feature]
  • [Key feature]
  • [Key feature]

Getting started

Prerequisites

  • [Runtime and version, e.g. Node.js 22+]
  • [Database or service, e.g. PostgreSQL 16]

Installation

git clone https://github.com/[user]/[repo].git
cd [repo]
[npm install]

Usage

[Show the most common way to use the project, with a short example.]

[npm run start]

Configuration

VariableDescriptionDefault
[API_KEY][What it is for][none]
[PORT][Port the server listens on][3000]

Running tests

[npm test]

Roadmap

  • [Planned feature]
  • [Planned feature]

Contributing

Contributions are welcome. Please open an issue to discuss what you'd like to change, then submit a pull request. See [CONTRIBUTING.md] for guidelines.

License

Distributed under the [MIT] License. See [LICENSE] for details.

Contact

[Your Name] · [email or handle] · [project URL]

Preview of the template. Highlighted [brackets] show text to replace.

How to use this README template

  1. Download the README.md file and place it in the root folder of your project.
  2. Replace everything in [brackets] with your project’s details.
  3. Delete sections you don’t need. A small script may only need a description, installation and usage.
  4. Add a screenshot or GIF near the top if your project has a user interface. It is the fastest way to show what it does.
  5. Commit it and check how it renders on GitHub or GitLab.

What makes a great README

  • A one-line description at the top. Visitors decide in seconds whether the project is relevant.
  • Copy-paste installation steps. Commands should work exactly as written.
  • A minimal working example of the most common use.
  • Clear configuration, with every environment variable explained.
  • How to get help: issues, discussions, chat or email.
  • The license, because without one, others cannot legally use your code.

Markdown quick reference

You type You get
# Heading Large heading
**bold** bold
[link](https://example.com) A link
`code` Inline code
Three backticks on separate lines A code block
- [ ] task A checkbox task list

Documenting an API as well? Use our API documentation template.

Frequently asked questions

What should a README file include?

At minimum, a project name and description, how to install it, how to use it, and the license. Good READMEs also cover configuration, tests, contributing guidelines and where to get help.

What format is a README file?

Most READMEs are written in Markdown and saved as README.md in the root of the repository. GitHub, GitLab and Bitbucket render Markdown automatically on the project's home page.

How long should a README be?

Long enough for a new developer to install and use the project without asking you questions. Keep the top section short, and link to separate documentation for detailed guides.

Related templates and guides