projects
/
cargo.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
e3a9bc6
)
Add instructions for rendering docs locally to the README
author
Carol (Nichols || Goulding)
<carol.nichols@gmail.com>
Fri, 13 May 2016 20:47:11 +0000
(16:47 -0400)
committer
Carol (Nichols || Goulding)
<carol.nichols@gmail.com>
Fri, 13 May 2016 20:47:11 +0000
(16:47 -0400)
README.md
patch
|
blob
|
history
diff --git
a/README.md
b/README.md
index 1ad7556b66a6bb897ffd26141f0cfef55e8a7943..49d73629aae022ff0fa5d5beba731df45f5007f4 100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-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