~charles/templates

ref: 5927eff8ed94153a2724e5d9801fcb3be9bab52a templates/report/README.md -rw-r--r-- 2.1 KiB
5927eff8Charles Daniels fix README 5 months ago

#Report Template

back to top level

This template is suitable for simple reports, documents, homework assignments, etc. Documents are written in Markdown, then processed through Pweave and pandoc to produce a PDF.

The most excellent Eisvogel template is included in the ./eisvogel directory. Eisvogel is distributed under it's own BSD 3-clause license. Eisvogel was last updated 2020-11-08, and is level with v1.6.0 from the upstream.

#How to Use It

All .pmd documents are processed through Pweave to generate corresponding markdown documents, which are then processed using pandoc into PDFs. The main.bib file will be used for the bibliography.

make will generate .pdf file for each .pmd file. Additionally, any IPE files (.ipe) will be converted to .eps format (suitable for embedding as figures)

make clean will delete all PDFs generated programatically, as well as all temporary build artifacts, figures, etc.

See ./report.pmd for an example of how to write a report with this system.

NOTE: the directory ./figures is generated programatically by Pweave and will be deleted each time make clean is issued.

#Requirements

Mandatory requirements:

  • GNU make
    • Tested working with GNU Make 4.2.1
  • Pandoc
    • Tested working with pandoc 2.11.1.1
    • Older versions may require you to install pandoc-citeproc separately.
  • Python 3.x
    • Required for Pweave
    • Tested working with Python 3.6.8
  • Pweave
    • Tested working with Pweave 0.30.3
  • TexLive
    • Needed so pandoc can produce PDFs
    • Tested working with TeX Live 2020

Optional requirements:

  • Ipe
    • Needed only for compiling .ipe figures
    • Tested working with Ipe 7.2.21