~charles/templates

5927eff8ed94153a2724e5d9801fcb3be9bab52a — Charles Daniels 5 months ago 450c549
fix README
2 files changed, 64 insertions(+), 0 deletions(-)

M slides/.gitignore
A slides/README.md
M slides/.gitignore => slides/.gitignore +1 -0
@@ 2,3 2,4 @@
*.md
*.eps
figures/
*.html

A slides/README.md => slides/README.md +63 -0
@@ 0,0 1,63 @@
# Report Template

[back to top level](./../README.md)

This template is suitable for creating slideshows. It is based on the [report
template](../report/README.md). Slides are written in Markdown, with top-level
headers used to delineate slides form each other.

The most excellent
[Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template) template is
included in the [`./eisvogel`](./eisvogel) directory. Eisvogel is distributed
under it's own [BSD 3-clause license](./eisvogel/LICENSE).  Eisvogel was last
updated 2020-11-08, and is level with
[v1.6.0](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/tag/v1.6.0)
from the upstream.

Note that Eisvogel is used for PDF output, because it makes the listings work
better in Beamer. It is not used for HTML output, as Eisvogel is suitable only
for TeX based output formats.

## 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 a `.pdf` file and a `.html` fiel for each `.pmd` file.
Additionally, any [IPE](http://ipe.otfried.org/) files (`.ipe`) will be
converted to `.eps` format (suitable for embedding as figures)

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

See `./slides.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](https://pandoc.org/)
  * Tested working with pandoc 2.11.1.1
  * Older versions may require you to install
  [pandoc-citeproc](https://github.com/jgm/pandoc-citeproc) separately.
* [Python 3.x](https://www.python.org/)
  * Required for Pweave
  * Tested working with Python 3.6.8
* [Pweave](https://github.com/mpastell/Pweave)
  * Tested working with Pweave 0.30.3
* [TexLive](http://tug.org/texlive/)
  * Needed so pandoc can produce PDFs
  * Tested working with TeX Live 2020

Optional requirements:
* [Ipe](http://ipe.otfried.org/)
  * Needed only for compiling `.ipe` figures
  * Tested working with Ipe 7.2.21