project setup

This commit is contained in:
Jannik Beyerstedt 2025-11-15 12:00:57 +01:00
commit cd873532ca
3 changed files with 20 additions and 0 deletions

17
Readme.md Normal file
View file

@ -0,0 +1,17 @@
# c3voc Handbook
This repo contains some handbook/ documentation of the c3voc recording setup.
The intended audience is: A/V technicians and VOC responsible persons (everybody who handles the hall equipment from a technical point of view) as well as general camera and video mixer angels.
## Usage
The documentation is based on [MkDocs](https://www.mkdocs.org) using Markdown syntax for the content.
To run it locally, install the python packages listed in the `requirements.txt` (preferably in a venv) like this:
```shell
pip install -r requirements.txt
```
Then serve the site locally with:
```shell
mkdocs serve
```