1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
|
# rustup documentation
This directory contains rustup's developer / contributing documentation.
## Building the book
Building the book requires [mdBook](https://github.com/rust-lang/mdBook). To get it:
```console
$ cargo install mdbook
```
To build the book:
```console
$ mdbook build
```
`mdbook` provides a variety of different commands and options to help you work
on the book:
* `mdbook build --open`: Build the book and open it in a web browser.
* `mdbook serve`: Launches a web server on localhost. It also automatically
rebuilds the book whenever any file changes and automatically reloads your
web browser.
The book contents are driven by the [`SUMMARY.md`](src/SUMMARY.md) file, and
every file must be linked there.
|