Coding Guidelines

What is this?

This document attempts to provide both general and for multiple programming languages specific guidelines.

How to build this site

Prerequisites

recent version of Python 3
recent version of pip

Preparation

optional: create a virtual environment and start it
run pip install -r .\requierments.txt to install all needed dependencies

Building

cd into the directory ./coding-guidelines
run mkdocs build

Serving development version

cd into the directory ./coding-guidelines
run mkdocs serve