Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.83 KB

README.md

File metadata and controls

64 lines (41 loc) · 2.83 KB

Document Template HS Coburg

This repository is based on the student-maintained and improved version of the outdated FEIF LaTeX document template. The template got reworked from the ground up, improving the author's experience and providing a cleaner interface to begin with.

While being a template, the project provides some useful commands and allows the user to further customize and extend it.

You can find an example document based on this template (including a small overview of features) over on the example branch. For further customization options or documentation please consult the template's wiki.

Important

The main branch can be considered "official" and should be used by students for writing theses and reports. Other branches, e.g. for active development or modifications, should be considered "unofficial".

Note

At this time, the template is set up to only support German (despite this README and the source code being commented and written in English).

Table of Contents:

Prerequisites

The build-pipeline associated to this project isn't tailored to an IDE like Overleaf. It can easily be run and built with whatever tool you prefer for writing lots of text.

If you want to build the template in your terminal (which can be much easier than getting an IDE to work), you need the following programs installed on your system:

Installation on Unix-like systems (Linux, MacOS)

Due to most distributions having outdated versions of texlive in their repositories, you are encouraged to download the texlive package as discribed over on the official website.

Installation on Windows

Installing programs for development on Windows can get annoying rather quickly. For this reason, we recommend using a package manager for Windows, namely scoop. We will only use it for one package, but having it on your system can't hurt.

To install make with scoop, run the following commands in your terminal:

scoop bucket add main
scoop install make

Install the complete TeXLive suite from https://tug.org/texlive/windows.html#install.

Compiling your document

Compiling your document is as easy as running the following command in your terminal.

make

To remove temporary files and indices used during compilation, run:

make clean