diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4c9d327 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +To build the contents of this repository locally, follow the steps below. + +1. Install sphinx and the read the docs theme + +``` +pip install sphinx sphinx-rtd-theme +``` + +2. Build the HTML + +``` +cd docs +make html +``` + +3. Open the HTML in your web browser + +``` +open _build/html/index.html +```