Skip to content

Commit f8acf4e

Browse files
committed
Document the new manifest keys
1 parent 640487c commit f8acf4e

File tree

2 files changed

+37
-4
lines changed

2 files changed

+37
-4
lines changed

Cargo.lock

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/doc/manifest.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,39 @@ the VCS's ignore settings (`.gitignore` for git for example).
6464
exclude = ["build/**/*.o", "doc/**/*.html"]
6565
```
6666

67+
## Package metadata
68+
69+
There are a number of optional metadata fields also accepted under the
70+
`[package]` section:
71+
72+
```toml
73+
[package]
74+
# ...
75+
76+
# A short blurb about the package. This is not rendered in any format when
77+
# uploaded to registries.
78+
description = "..."
79+
80+
# These URLs point to more information about the repository
81+
documentation = "..."
82+
homepage = "..."
83+
repository = "..."
84+
85+
# This points to a file in the repository (relative to this Cargo.toml). The
86+
# contents of this file are stored and indexed in the registry.
87+
readme = "..."
88+
89+
# This is a small list of keywords used to categorize and search for this
90+
# package.
91+
keywords = ["...", "..."]
92+
93+
# This is a string description of the license for this package. Currently
94+
# the registry will validate the license provided against a whitelist of known
95+
# licenses.
96+
license = "..."
97+
```
98+
99+
67100
# The `[dependencies.*]` Sections
68101

69102
You list dependencies using `[dependencies.<name>]`. For example, if you

0 commit comments

Comments
 (0)