Improved the user guide documentation for installing mdBook #2430
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ehuss
reviewed
Aug 26, 2024
| @@ -12,7 +12,7 @@ Executable binaries are available for download on the [GitHub Releases page][rel | |||
| Download the binary for your platform (Windows, macOS, or Linux) and extract the archive. | |||
| The archive contains an `mdbook` executable which you can run to build your books. | |||
|
|
|||
| To make it easier to run, put the path to the binary into your `PATH`. | |||
| To make it easier to run, put the path to the binary into your `PATH`. If you have an installation of Rust, you can move the binary to [Cargo's global installation directory](#cargos-global-installation-directory). | |||
There was a problem hiding this comment.
I would prefer to not encourage using cargo's bin directory for the purpose of installing arbitrary executables.
There was a problem hiding this comment.
I just realized that such method does not update .cargo/.crates.toml and .cargo/.crates2.json. I thought it's okay because there where the binary would end up if it were installed via cargo install.
| @@ -28,7 +28,7 @@ Once you have installed Rust, the following command can be used to build and ins | |||
| 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). | |||
| This will automatically download mdBook from [crates.io], build it, and install it in [Cargo's global binary directory](#cargos-global-installation-directory). | |||
There was a problem hiding this comment.
Instead of adding an entire section on this, can this just mention the two possibilities here? Perhaps something like:
Suggested change
| This will automatically download mdBook from [crates.io], build it, and install it in [Cargo's global binary directory](#cargos-global-installation-directory). | |
| This will automatically download mdBook from [crates.io], build it, and install it in Cargo's global binary directory (by default this is `~/.cargo/bin/` on unix-like platforms and `%USERPROFILE%\.cargo\bin\` on Windows). If you have an installation of Rust, this directory is most likely already in your `PATH`. |
|
I'm going to close due to inactivity. If you would like to update this, feel free to reopen. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I specified the location of Cargo's global installation directory depending on the operating system. Notably, it specifies the Windows-path, which is slightly distinct from the Linux and macOS paths.