From 94baf19e6ae355b8143b2d3075a5e3dfd21ed63e Mon Sep 17 00:00:00 2001 From: Radek Date: Wed, 7 Aug 2024 12:01:19 +0200 Subject: [PATCH 1/3] added update how to Updating workflow is not clear for non rust users. --- guide/src/guide/installation.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/guide/src/guide/installation.md b/guide/src/guide/installation.md index 3fe9e12a..0fc03d7d 100644 --- a/guide/src/guide/installation.md +++ b/guide/src/guide/installation.md @@ -47,6 +47,18 @@ cargo install --git https://github.com/rust-lang/mdBook.git mdbook Again, make sure to add the Cargo bin directory to your `PATH`. + +### Updating mdbook from source + +```sh +cargo install mdbook +``` + +This will automatically download mdBook from [crates.io], build it, and re-install it in Cargo's global binary directory (`~/.cargo/bin/` by default). + + +## Own modifications and contributing + If you are interested in making modifications to mdBook itself, check out the [Contributing Guide] for more information. [Contributing Guide]: https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md From 59d26dbbe7130cb78b41ec4fbaa033860a86a2dd Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sun, 11 Aug 2024 05:45:26 -0700 Subject: [PATCH 2/3] Move "upgrade mdbook" description to the build-from-source section --- guide/src/guide/installation.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/guide/src/guide/installation.md b/guide/src/guide/installation.md index 0fc03d7d..c9ac9505 100644 --- a/guide/src/guide/installation.md +++ b/guide/src/guide/installation.md @@ -30,6 +30,9 @@ cargo install mdbook This will automatically download mdBook from [crates.io], build it, and install it in Cargo's global binary directory (`~/.cargo/bin/` by default). +You can run `cargo install mdbook` again whenever you want to update to a new version. +That command will check if there is a newer version, and re-install mdBook if a newer version is found. + To uninstall, run the command `cargo uninstall mdbook`. [Rust installation page]: https://www.rust-lang.org/tools/install @@ -47,16 +50,6 @@ cargo install --git https://github.com/rust-lang/mdBook.git mdbook Again, make sure to add the Cargo bin directory to your `PATH`. - -### Updating mdbook from source - -```sh -cargo install mdbook -``` - -This will automatically download mdBook from [crates.io], build it, and re-install it in Cargo's global binary directory (`~/.cargo/bin/` by default). - - ## Own modifications and contributing If you are interested in making modifications to mdBook itself, check out the [Contributing Guide] for more information. From b51bb101f280ff87fc3271f6536e67e2f2c1cb51 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sun, 11 Aug 2024 05:46:48 -0700 Subject: [PATCH 3/3] Tweak heading wording --- guide/src/guide/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/guide/installation.md b/guide/src/guide/installation.md index c9ac9505..173b078c 100644 --- a/guide/src/guide/installation.md +++ b/guide/src/guide/installation.md @@ -50,7 +50,7 @@ cargo install --git https://github.com/rust-lang/mdBook.git mdbook Again, make sure to add the Cargo bin directory to your `PATH`. -## Own modifications and contributing +## Modifying and contributing If you are interested in making modifications to mdBook itself, check out the [Contributing Guide] for more information.