docs: explain how to preview changes
Your own changes or someone else's.
[email protected],
BUG=571125
Review URL: https://codereview.chromium.org/1535273002
Cr-Commit-Position: refs/heads/master@{#366287}
diff --git a/docs/README.md b/docs/README.md
index 6bd588f..c37c54d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,5 +8,23 @@
Markdown documents must follow the [style guide].
+## Previewing changes
+
+You can preview your local changes using [md_browser]:
+
+```bash
+# in chromium checkout
+python tools/md_browser/md_browser.py
+```
+
+To review someone else's changes, apply them locally first:
+
+```bash
+# in chromium checkout
+git cl patch <CL number or URL>
+python tools/md_browser/md_browser.py
+```
+
[Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md
[style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide
+[md_browser]: ../tools/md_browser/
\ No newline at end of file
