Skip to content

Commit 6e1eda7

Browse files
authored
Minor improvements to the installation chapter (#914)
1 parent 680405e commit 6e1eda7

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

book/installation.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ For Windows:
2222

2323
Cross Platform installation:
2424

25-
- [npm](https://www.npmjs.com/) (`npm install -g nushell` Note that nu plugins were not included if you install in this way)
25+
- [npm](https://www.npmjs.com/) (`npm install -g nushell` Note that nu plugins are not included if you install in this way)
2626

2727
The main Nushell binary is named `nu` (or `nu.exe` on Windows). After installation, you can launch it by typing `nu`.
2828

29+
@[code](@snippets/installation/run_nu.sh)
30+
2931
## Build from source
3032

3133
You can also build Nu from source. First, you will need to set up the Rust toolchain and its dependencies.
@@ -42,13 +44,13 @@ For Rust to work properly, you'll need to have a compatible compiler suite insta
4244

4345
### Installing Rust
4446

45-
If we don't already have Rust on our system, the best way to install it is via [rustup](https://rustup.rs/). Rustup is a way of managing Rust installations, including managing using different Rust versions.
47+
If you don't already have Rust on our system, the best way to install it is via [rustup](https://rustup.rs/). Rustup is a way of managing Rust installations, including managing using different Rust versions.
4648

4749
Nu currently requires the **latest stable (1.66.1 or later)** version of Rust. The best way is to let `rustup` find the correct version for you. When you first open `rustup` it will ask what version of Rust you wish to install:
4850

4951
@[code](@snippets/installation/rustup_choose_rust_version.sh)
5052

51-
Once we are ready, we press 1 and then enter.
53+
Once you are ready, press 1 and then enter.
5254

5355
If you'd rather not install Rust via `rustup`, you can also install it via other methods (e.g. from a package in a Linux distro). Just be sure to install a version of Rust that is 1.66.1 or later.
5456

@@ -74,31 +76,27 @@ Using [Homebrew](https://brew.sh/), you will need to install "openssl" and "cmak
7476

7577
### Build using [crates.io](https://crates.io)
7678

77-
Nu releases are published as source to the popular Rust package registry [crates.io](https://crates.io/). This makes it easy to build+install the latest Nu release with `cargo`:
79+
Nu releases are published as source to the popular Rust package registry [crates.io](https://crates.io/). This makes it easy to build and install the latest Nu release with `cargo`:
7880

7981
@[code](@snippets/installation/cargo_install_nu.sh)
8082

81-
That's it! The `cargo` tool will do the work of downloading Nu and its source dependencies, building it, and installing it into the cargo bin path so we can run it.
83+
That's it! The `cargo` tool will do the work of downloading Nu and its source dependencies, building it, and installing it into the cargo bin path.
8284

8385
If you want to install with support for [dataframes](dataframes.md), you can install using the `--features=dataframe` flag.
8486

8587
@[code](@snippets/installation/cargo_install_nu_more_features.sh)
8688

87-
Once installed, we can run Nu using the `nu` command:
88-
89-
@[code](@snippets/installation/crates_run_nu.sh)
90-
9189
### Building from the GitHub repository
9290

93-
We can also build our own Nu from the latest source on GitHub. This gives us immediate access to the latest features and bug fixes. First, clone the repo:
91+
You can also build Nu from the latest source on GitHub. This gives you immediate access to the latest features and bug fixes. First, clone the repo:
9492

9593
@[code](@snippets/installation/git_clone_nu.sh)
9694

9795
From there, we can build and run Nu with:
9896

9997
@[code](@snippets/installation/build_nu_from_source.sh)
10098

101-
You can also build and run Nu in release mode:
99+
You can also build and run Nu in release mode, which enables more optimizations:
102100

103101
@[code](@snippets/installation/build_nu_from_source_release.sh)
104102

0 commit comments

Comments
 (0)