Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Manifest Format section in README.md #175

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update to Manifest Format section in README.md #175

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bdd9116
Update README.md
Aizakkuz Sep 22, 2023
0e0d002
Update README.md
Aizakkuz Sep 22, 2023
83512a7
Update README.md
Aizakkuz Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@ The package manifest file describes a package and all of the packages it depends

Manifest files are written by humans. They can contain comments and formatting decisions that are tough to preserve with automatic editing tools. This should be okay -- editing a package manifest should be easy.

Manifest files define all necessary information about a package.
[Manifest files](https://en.wikipedia.org/wiki/Manifest_file) define all necessary information about a package.

The concept of this package [manifest](https://doc.rust-lang.org/cargo/reference/manifest.html) file draws inspiration from Rust's package manager, Cargo. In both of these cases, this file is aptly referred to as a 'manifest' because it serves as the central document that outlines how a project should be built, configured, and managed.

Here is an example package manifest, annotated with comments:

Expand Down