X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=67285da2e3a6518294d898bd6fc4eab7d310f7a3;hb=c9fc4efd24ede43bed844f44a14b35eb406825aa;hp=0ae93380e5920dab03029f9c2c798a065073faf7;hpb=837ae4f3d417151c3d2b38672bf92174d8d9266b;p=rust.git diff --git a/README.md b/README.md index 0ae93380e59..67285da2e3a 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,9 @@ Read ["Installing Rust"] from [The Book]. tools. ```sh + # Update package mirrors (may be needed if you have a fresh install of MSYS2) + $ pacman -Sy pacman-mirrors + # Choose one based on platform: $ pacman -S mingw-w64-i686-toolchain $ pacman -S mingw-w64-x86_64-toolchain @@ -82,6 +85,28 @@ Read ["Installing Rust"] from [The Book]. $ make && make install ``` +## Building Documentation + +If you’d like to build the documentation, it’s almost the same: + +```sh +./configure +$ make docs +``` + +Building the documentation requires building the compiler, so the above +details will apply. Once you have the compiler built, you can + +```sh +$ make docs NO_REBUILD=1 +``` + +To make sure you don’t re-build the compiler because you made a change +to some documentation. + +The generated documentation will appear in a top-level `doc` directory, +created by the `make` rule. + ## Notes Since the Rust compiler is written in Rust, it must be built by a