mirryi / beamerfw

Beamer project template with support for multiple build methods.

Beamer Project Framework

Beamer project template using Metropolis theme.

Features

• Multiple build methods

  • Using the system TeX installation

  • Using TinyTeX

  • Using Docker

• GitHub action to build the PDF on push

• Decent file organization

Building

Requirements for main document (if not using Docker):

• Python 3.6+

  • Alternatively, a TeX installation (see packages.txt for list of extra required packages)

Unix

To build on Unix/Linux/macOS without a TeX installation:

./install.py install
. local/activate
latexmk                       # or: make index
                              # build should be at target/index.pdf

deactivate                    # when leaving the project directory

With a TeX installation:

tlmgr install $(cat packages) # if missing any required packages
latexmk                       # or: make index

Windows

To build on Windows without a TeX installation (not tested):

python3 install.py install
. local/activate.ps1
latexmk                       # or: make index
                              # build should be at target/index.pdf

deactivate                    # when leaving the project directory

With a TeX installation:

# install any missing packages specified in packages.txt
latexmk                       # or: make index

Docker

To build with Docker:

DOCKER_BUILDKIT=1 docker build --output target .  # build should be at target/index.pdf

License

This project is licensed under the MIT license. See LICENSE.txt for more details.