From 6a0d1e4dc3cf0f8e4c004e3f2980b1220041341f Mon Sep 17 00:00:00 2001 From: "an.tsouchlos" Date: Mon, 8 Jan 2024 13:33:00 +0000 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8541b6a..c524ba4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ba-letter -Repository containing latex source for the Bachelor's Thesis paper. +Repository containing the latex source for the bachelor's thesis letter. After cloning, make sure to initialize the submodules containing the dependencies: ```bash @@ -11,17 +11,24 @@ $ git submodule update --init ### Build on host +For a list of dependencies consult one of the dockerfiles in the `dockerfiles` directory. Build document: + ```bash $ make ``` +After compiling, the PDF can be found in the `build` directory. + ### Build using docker +Be warned that `texlive` installations can take some time. +Building the docker image may take a few minutes. + 1. Build docker image ```bash $ docker build -f dockerfiles/Dockerfile.alpine . -t ba-letter ``` -2. Build examples +2. Build document ```bash $ docker run --rm -v $PWD:$PWD -w $PWD -u `id -u`:`id -g` ba-letter make ```