project setup
This commit is contained in:
commit
cd873532ca
3 changed files with 20 additions and 0 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
/site
|
||||
17
Readme.md
Normal file
17
Readme.md
Normal 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
|
||||
```
|
||||
|
||||
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
mkdocs
|
||||
mkdocs-shadcn
|
||||
Loading…
Add table
Add a link
Reference in a new issue