Skip to content

Commit 54b0432

Browse files
committed
Update documentation for the readme field
1 parent dcae5fc commit 54b0432

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/doc/src/reference/manifest.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,11 @@ will interpret it as Markdown and render it on the crate's page.
165165
readme = "README.md"
166166
```
167167

168+
If no value is specified for this field, and a file named `README.md`,
169+
`README.txt` or `README` exists in the package root, then the name of that
170+
file will be used. You can suppress this behavior by setting this field to
171+
`"false"`.
172+
168173
#### The `homepage` field
169174

170175
The `homepage` field should be a URL to a site that is the home page for your

0 commit comments

Comments
 (0)