04b72ff07d
We had a suggestion that the dev docs would be easier to read if there was a table of contents. Rather than making one by hand I thought using mdbook would be better.
738 B
738 B
rustup documentation
This directory contains rustup's developer / contributing documentation.
Building the book
Building the book requires mdBook. To get it:
$ cargo install mdbook
To build the book:
$ 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 file, and
every file must be linked there.