Skip to content

Commit

Permalink
doc: additional true ups
Browse files Browse the repository at this point in the history
  • Loading branch information
canardleteer committed Dec 10, 2023
1 parent 520bb07 commit 2e8408b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Quickly Explore The Rust Toolbox

- The guide to accompany this repository, is now hosted on Gitlab Pages: [https://canardleteer.github.io/quickly-explore-rs/](https://canardleteer.github.io/quickly-explore-rs/)
- The guide to accompany this repository, is now hosted on Gitlab Pages:
- [https://canardleteer.github.io/quickly-explore-rs/](https://canardleteer.github.io/quickly-explore-rs/)

- Assuming you have `mdbook` installed, you can view it locally via:

Expand Down
14 changes: 14 additions & 0 deletions book/src/09-00-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,22 @@
- `cargo install mdbook`
- [repo](https://github.com/rust-lang/mdBook)

## Use `rg` after install

```shell
rg "# Install Some Useful Tools" .
```

And it should find the Markdown source for this chapter.

## Use `mdbook` after install

To locally view this book:

```shell
mdbook serve book
```

And it would then be serving at:

- [http://127.0.0.1:3000](http://127.0.0.1:3000)
4 changes: 3 additions & 1 deletion book/src/10-01-cargo-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

First, let's add the extremely useful `clap` library to our `Cargo.toml`. Start by checking out the [crate page](https://crates.io/crates/clap).

I am pinning the version, to `4.4.11`, and adding 2 Features: `derive` and `env`. "Features" are important to know about, but I'm not going to cover them here. You can [read up on them](https://doc.rust-lang.org/cargo/reference/features.html).
I am pinning the version, to `4.4.11`, and adding 2 Features: `derive` and `env`.

- "Features" for crates are important to know about, but I'm not going to cover them here. You can [read up on them](https://doc.rust-lang.org/cargo/reference/features.html).

```shell
-> cargo add [email protected] --features derive,env
Expand Down

0 comments on commit 2e8408b

Please sign in to comment.