No Description

Joost Sijm fdbcd44718 Finished the document 8 months ago
examples f7d3216baa Moved docs to example 2 years ago
src fdbcd44718 Finished the document 8 months ago
.env fdbcd44718 Finished the document 8 months ago
.gitignore a8d6569ef8 Add docs 2 years ago
Makefile 7ad73aad48 Add filled in personal form 9 months ago
README.md 02b9b4262e Update ignore and publish function in Makefile 3 years ago

README.md

HvA LaTeX Report Template

Document template for HvA report. Main LaTex file: main.tex

Requirements

Required packages:

  • LaTeX
  • GNU Make (advised)

Setup

  • run make init to generate config.tex and .env files. Alternative copy example.config.tex to config.tex and example.env to .env.
  • edit values in config.tex with

config.tex

Configuration file for LaTeX, leave value empty if field is not required.

.env

  • document: name of the main latex document, without extension
  • publish: name of file to publish to, without extension

GNU Make

Run make <option> in the command line. Default option for Make is pdf.

Options:

  • pdf : generate document as pdf
  • publish : make a copy of pdf with desired name
  • watch : continuous watch for changes
  • clean : remover regeneratable latex files, except output
  • purge : remove regeneratable latex files
  • init : create config.tex and .env files
  • config : make clean config.tex file
  • env : copy clean .env file
  • ignore : add config.tex and .env to .gitignore
  • acknowledge : remove config.tex and .env from .gitignore