From d4b4c04bac8d3eb941d3863230160e308656f59a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Sat, 24 Dec 2022 12:32:25 +0100 Subject: [PATCH] Add Contributing --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md 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 +```