Add CONTRIBUTING.md

- Add requirements for debian hosts
- Add section that explains how to add new docs.
This commit is contained in:
Ivan Smirnov 2020-06-25 15:07:32 -07:00 committed by Pēteris Caune
parent e2576607f5
commit 0c58a9b9ee

17
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,17 @@
# Contributing
## Dependencies
On Debian:
```
sudo apt install libpq-dev
pip3 install -r requirements.txt
pip3 install markdown django
```
## Adding Documentation
1. Create the appropriate markdown page under `templates/docs`
2. Add the page to `/templates/front/base_docs.html`
3. Generate the HTML assets with `python3 manage.py render_docs` - note that the `manage.py` is in the root of the project.