# dbader/readme-template

README.md template for your open-source project

Repository: https://github.com/dbader/readme-template
Canonical: https://ross.abutalabs.com/products/dbader-readme-template
Homepage: https://dbader.org/blog/write-a-great-readme-for-your-github-project
License Family: other
Last push: 2023-04-04T09:30:20+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3850, "days_push": 1247, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1972, forks 4021 (observed 2026-08-28T04:06:00.963884+00:00)

## What it is
A README.md template for open-source projects, accompanying a guide on writing great README files. It provides a fill-in-the-blank structure covering installation, usage, development setup, release history, and contributing guidelines.

## Use cases
- write a readme for my github project
- readme template for open source project
- what sections should a readme have
- markdown readme boilerplate
- structure documentation for a new repo

## When to choose
- starting a new open-source project and needing a README skeleton
- wanting a simple, proven README structure without tooling

## When to avoid
- needing automated README generation or linting
- requiring a maintained tool rather than a static template

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: documentation, markdown
- domain: documentation, developer-tools
- platform: cross-platform
- tags: readme-template, boilerplate, github, open-source

## Member repositories
- dbader/readme-template (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:00.963884+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:05:01.537997+00:00, confidence not recorded.
  - readme: https://github.com/dbader/readme-template (fetched 2026-08-28T04:06:00.963884+00:00, sha e5a762dfb55b)
  - homepage: https://dbader.org/blog/write-a-great-readme-for-your-github-project (fetched 2026-08-29T10:44:44.866561+00:00, sha 54af560df8ab)
  - site_page: https://dbader.org/blog/open-source-tools-to-generate-and-host-your-api-documentation-for-free (fetched 2026-08-29T10:44:44.877697+00:00, sha 65186cbdb876)
  - site_page: https://dbader.org/blog/my-favourite-books-about-programming (fetched 2026-08-29T10:44:44.879775+00:00, sha 6621ca1f7b14)
- Data as of 2026-08-30T08:39:29.467469+00:00.