summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-08-18 13:49:20 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-08-18 13:49:20 -0400
commitfd53ea28d8a85ceec71bd5f4016c44eab7e58ccf (patch)
tree36e2aa8329498109f860485cae6216dd9021eb55 /README.md
parentc6291e04cc620ce3824d8bccdb8a5bd923fcd741 (diff)
Add notes about building documentation to the README.
Fixes #27632
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0ae93380e59..391ada0efef 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,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