fh-trier
/
linux_ws2122
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

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

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