doc(README): compile instructions
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Markus Pesch 2021-10-13 20:15:27 +02:00
parent 106f8d927b
commit 0bdd5867d4
Signed by: volker.raschek
GPG Key ID: 852BCC170D81A982
2 changed files with 19 additions and 43 deletions

View File

@ -13,7 +13,7 @@ CONTAINER_RUNTIME?=$(shell which docker)
# source code
BUILD_IMAGE_REGISTRY:=docker.io
BUILD_IMAGE_NAMESPACE:=volkerraschek
BUILD_IMAGE_NAME:=container-latex
BUILD_IMAGE_NAME:=latex
BUILD_IMAGE_VERSION:=latest-archlinux
BUILD_IMAGE_FULL=${BUILD_IMAGE_REGISTRY}/${BUILD_IMAGE_NAMESPACE}/${BUILD_IMAGE_NAME}:${BUILD_IMAGE_VERSION}
BUILD_IMAGE_SHORT=${BUILD_IMAGE_NAMESPACE}/${BUILD_IMAGE_NAME}:${BUILD_IMAGE_VERSION}

View File

@ -2,58 +2,42 @@
[![Build Status](https://drone.cryptic.systems/api/badges/fh-trier/linux_ws2021/status.svg)](https://drone.cryptic.systems/fh-trier/linux_ws2021)
This repository contains the latex source code of the linux module on the
University of Applied Science for WS20/21.
This repository contains the latex source code of the module *Linux /
Betriebssysteme* of the University of Applied Science for the winter semester
21/22.
The document contains all tasks which the students should could solve before
they write their linux exam.
The document contains tasks which students should could solve before they write
their exam.
## Compiling the PDF document
There are two ways to compile the PDF document. Since the templates contain all
dependencies to the package `minted`, it is probably easier to use a container
image to compile the document.
There are two ways to compile the PDF document. Via a local installed latex
environment which must be fullfil the dependencies or via a container image wich
has all dependencies included (it is probably easier to use a container image to
compile the document).
To do this, install docker or podman as container runtime and Make as build
tool. If you have docker or podman and Make installed execute `make
To do this, install `docker` or `podman` as container runtime and `make` as
build tool. If you have `docker` or `podman` and `make` installed execute `make
container-run/latexmk/index.pdf` to compile the PDF document by using a
container image.
If you don't want to install a container runtime and the build tool make, you
have to install texlive manually - [installation instructions](https://www.tug.org/texlive/).
If you don't want to install a container runtime and the build tool `make`, you
have to install texlive manually - [installation
instructions](https://www.tug.org/texlive/).
## make commands
### clean
Deletes all files that were not checked in using git.
```bash
make clean
```
### container-run/latexmk
Uses a docker container to compile the PDF document with `latexmk` By default
the docker container `volkerraschek/container-latex:latest-ubuntu18.04` is used.
However, it can also be modified. The Makefile contains the variables with the
prefix `BUILD_IMAGE` to change the full qualified image path for this purpose.
However, you may have to change the docker command call in `container-run` if
necessary.
Uses a container image to compile the PDF document with `latexmk`. By default
the docker container `volkerraschek/latex:latest-archlinux` is used. However, it
can also be modified. The Makefile contains the variables with the prefix
`BUILD_IMAGE` to change the full qualified image name.
```bash
make container-run/latexmk/index.pdf
```
### container-run/pdflatex
Similar to container-run/latexmk/index.pdf, but in the container pdflatex will
be execute instead of latexmk.
```bash
make container-run/pdflatex/index.pdf
```
### latexmk
Executes latexmk natively in the system environment.
@ -61,11 +45,3 @@ Executes latexmk natively in the system environment.
```bash
make latexmk/index.pdf
```
### pdflatex
Executes pdflatex natively in the system environment.
```bash
make pdflatex
```