go-profiler-notes/CONTRIBUTING.md
Felix Geisendörfer d4b4c04bac Add Contributing
2022-12-29 14:04:52 +01:00

22 lines
303 B
Markdown

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