spearbit-audits / report-template

A markdown based template for writing spearbit reports

A Markdown based template for writing audit reports

Requirements

1. Pandoc
2. Pandocfilters: pip install pandocfilters.
3. LaTeX toolchain. We recommend a full install of LaTeX (installing individual .sty files are hard).
4. Pygments: pip install pygments.
5. bash

Manual Changes

Manually update title.tex and summary.tex.

Generating the PDF

Manually: Run ./generate.sh. The report would be generated

CI: There is a github action that generates the PDF.

1. Go to Actions, click on the last workflow.
2. Artifacts -> Spearbit.pdf: a ZIP file containing the pdf.