Add Contributing

This commit is contained in:
Felix Geisendörfer 2022-12-24 12:32:25 +01:00
parent a95329bdb7
commit d4b4c04bac

22
CONTRIBUTING.md Normal file
View file

@ -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
```