This project is for authoring and generating the AV1 RTP Payload Format specification document.

The specification is written using a special syntax (mixing markup and markdown) to enable generation of cross-references, syntax highlighting, etc. The file using this syntax is index.bs.

index.bs is processed to produce an HTML version (index.html) by a tool called Bikeshed, which is run when content is pushed onto the main branch or when Pull Requests are made.

Building locally

Make sure python is installed on your system. It is recommended to use a dedicated environment, if you haven't done so you can set it up like this:

python3 -m venv venv
source venv/bin/activate

Then install dependencies using:

pip install -r requirements.txt

Finally you can compile the spec by running:

bikeshed spec