diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 0c483b1fb..ae917b48a 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -24,8 +24,9 @@

Notes on using Docs.rs

Setting a README

- The README of a crate is taken from the readme field defined in - Cargo.toml. If this field is not set, no README will be displayed. + The README displayed on docs.rs follows Cargo’s package.readme rules. + If readme is not set, docs.rs will look for README.md, README.txt, or README in the crate root. + Set readme = "path/to/file" to use a custom file, readme = true to use README.md, or readme = false to disable the README.

Detecting Docs.rs