itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for rendering docs locally to the README

Browse Source
This commit is contained in:
Carol (Nichols || Goulding) 2016-05-13 16:47:11 -04:00
parent e3a9bc698d
commit 9e0da6fb20
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -87,7 +87,14 @@ a list of known community-developed subcommands.
## Contributing to the Docs
To contribute to the docs, all you need to do is change the markdown files in
the `src/doc` directory.
the `src/doc` directory. To view the rendered version of changes you have
made locally, run:
```sh
./configure
make doc
open target/doc/index.html
```
## Release notes