Browse Source
Add CONTRIBUTING.md
- Add requirements for debian hosts
- Add section that explains how to add new docs.
pull/390/head
Ivan Smirnov
4 years ago
committed by
Pēteris Caune
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
1 changed files with
17 additions and
0 deletions
-
CONTRIBUTING.md
|
|
@ -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. |