docs: Update README to include GraphViz installation requirement

openedx · Dec 17, 2021 · 95aff5c · 95aff5c
1 parent becb959
commit 95aff5c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -16,7 +16,10 @@ View the published list of `Open edX Proposals (OEPs)`_ on ReadTheDocs.
 Testing locally
 ---------------
 
-To test locally in a Python virtual env::
+To test locally in a Python virtual env, you will first need to install `GraphViz <http://graphviz.org/>`_
+and either ``dot`` on the path or
+`adding options to the make call <https://groups.google.com/forum/#!topic/sphinx-users/yXgNey_0M3I>`_.
+On a Mac, this can be done via `brew install graphviz`. Next run the following commands::
 
   pip install sphinx  # it may fail for non-obvious reasons without this
   make requirements