Contributing to the Project

If you want to contribute to the project, feel free to send a PR to Andrey Zhdanov.

Coding conventions

Since VideoRecStation is built on Qt, in general, try to follow Qt’s Coding Conventions, and in particular Qt Coding Style whenever it makes sense.

Building the documentation

The documentation for the project is written in reStructuredText and is compiled into html using Sphinx and Furo theme. To edit the documentation, modify the sources in the docs/src folder. To buld the html files, install Sphinx and Furo on you computer, then from the docs folder run:

sphinx-build -M html src html

Note

If you have conda installed on your machine, you can install Sphinx and Furo into a new conda environment named sphinx by running:

conda create -n sphinx sphinx furo -c conda-forge