From d4604bf2de08b02aa04011fcc6d65ec70fe5181d Mon Sep 17 00:00:00 2001 From: jtbx Date: Sat, 15 Nov 2025 12:00:57 +0100 Subject: [PATCH] project setup --- .gitignore | 1 + Readme.md | 17 +++++++++++++++++ requirements.txt | 2 ++ 3 files changed, 20 insertions(+) create mode 100644 .gitignore create mode 100644 Readme.md create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c9490a5 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/site diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..19a170b --- /dev/null +++ b/Readme.md @@ -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 +``` + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f6167f1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs +mkdocs-shadcn