Home > Software engineering >  Which names does GitHub recognize as README's?
Which names does GitHub recognize as README's?

Time:12-04

I know there are several names that get recognized by GitHub as README's, e.g. README, README.md.
What is an exhaustive list of such names?

CodePudding user response:

I found a searching rule

const PATTERN = /^readme\.(?:markdown|mdown|mkdn|md|textile|rdoc|org|creole|mediawiki|wiki|rst|asciidoc|adoc|asc|pod|txt)/i
  • Related