From bdd91163a799ca87c813aeda0b35e8002c2e1479 Mon Sep 17 00:00:00 2001 From: AizakkuZ <56370516+Aizakkuz@users.noreply.github.com> Date: Fri, 22 Sep 2023 10:51:00 -0500 Subject: [PATCH 1/3] Update README.md This additional information felt necessary because not everyone knows what a `manifest` file is, and giving some background information might help solidify that understanding even more. Before understanding this background information, this felt like a completely new concept. When I just recently started reading the Rust Programming Language Book cover to cover, I noticed that quite a bit of what is given here began to click extremely well. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 312d554..0a12ac2 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,8 @@ Manifest files are written by humans. They can contain comments and formatting d Manifest files define all necessary information about a package. +The concept of a 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. The term 'manifest' signifies that this file encapsulates all the essential information and metadata required to describe the current project and its dependencies; similarly extending to when working with package manifest files in the context of Wally. + Here is an example package manifest, annotated with comments: ```toml From 0e0d0023d8c8a252d0bfb66649cc49723db1b408 Mon Sep 17 00:00:00 2001 From: AizakkuZ <56370516+Aizakkuz@users.noreply.github.com> Date: Fri, 22 Sep 2023 12:02:57 -0500 Subject: [PATCH 2/3] Update README.md This additional information felt necessary because not everyone might be familiar with the term 'manifest file' in the context of a package manager. Providing some background information could help solidify that understanding even further. Before delving into this background information, the concept felt entirely new to me. It wasn't until I recently began reading The Rust Programming Language Book from cover to cover that many pieces of the puzzle began to fall into place. While there's [this source](https://en.wikipedia.org/wiki/Manifest_file) that provides a general description of a 'manifest file,' it doesn't delve into its connection to Rust, and the Cargo package manager. Linking everything back to Rust and Cargo seems quite fitting. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a12ac2..65e00a5 100644 --- a/README.md +++ b/README.md @@ -137,9 +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 a 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. The term 'manifest' signifies that this file encapsulates all the essential information and metadata required to describe the current project and its dependencies; similarly extending to when working with package manifest files in the context of Wally. +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. The term 'manifest' signifies that this file encapsulates all the essential information and metadata required to describe the current project and its dependencies; similarly extending to when working with package manifest files in the context of Wally. Here is an example package manifest, annotated with comments: From 83512a712e535bf9a05303aee8ae3ad7960a7453 Mon Sep 17 00:00:00 2001 From: AizakkuZ <56370516+Aizakkuz@users.noreply.github.com> Date: Fri, 22 Sep 2023 12:37:08 -0500 Subject: [PATCH 3/3] Update README.md This felt necessary, as that sentence felt slightly redundant. Package manifest file was effectively defined above, so that sentence wouldn't remove much substance if it were cut out. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65e00a5..eb7a70d 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ Manifest files are written by humans. They can contain comments and formatting d [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. The term 'manifest' signifies that this file encapsulates all the essential information and metadata required to describe the current project and its dependencies; similarly extending to when working with package manifest files in the context of Wally. +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: