diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2015-09-26 18:00:39 -0600 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2015-09-26 18:00:39 -0600 |
| commit | cc44d65c19835ff24aa3bfa5b76231d522fd0070 (patch) | |
| tree | 249ce1e60b72a87140aa2b1f9443056c802e8295 /src | |
| parent | 3e36eecae4a829cae531c3104547678504e11c72 (diff) | |
| parent | 865889a2ccf6c217df158b5e088b2fba71e86da4 (diff) | |
| download | rust-cc44d65c19835ff24aa3bfa5b76231d522fd0070.tar.gz rust-cc44d65c19835ff24aa3bfa5b76231d522fd0070.zip | |
Rollup merge of #28680 - xaviershay:doc-readme, r=steveklabnik
This wasn't complete (you need a `./configure`), and it is already documented well in the main README. r? @steveklabnik
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/README.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/doc/README.md b/src/doc/README.md index c09f28ae4f6..0882b073ea4 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -2,9 +2,10 @@ ## Building -To generate all the docs, just run `make docs` from the root of the repository. -This will convert the distributed Markdown docs to HTML and generate HTML doc -for the 'std' and 'extra' libraries. +To generate all the docs, follow the "Building Documentation" instructions in +the README in the root of the repository. This will convert the distributed +Markdown docs to HTML and generate HTML doc for the books, 'std' and 'extra' +libraries. To generate HTML documentation from one source file/crate, do something like: |