From f9c95103dbd12241e82cecb1e671aa9e4dd4bb57 Mon Sep 17 00:00:00 2001 From: Michael Bredel <michael@bredel.at> Date: Sun, 12 Nov 2017 10:15:55 +0100 Subject: [PATCH 1/6] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 294e3fe..c9122cd 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,11 @@ to remove all temporary files, which are produced during the compilation process $ make bz2 ``` -generates a bz2-package file, which contains all the source files of your LaTeX code. +generates a bz2-package file, which contains all the source files of your LaTeX code. In case you need to create a PDF-version with embedded fonts you may use + +``` + $ make publish +``` ## Known issues From 7d9999d66aeeb66b698fbac544302e51da9b3b2c Mon Sep 17 00:00:00 2001 From: Michael Bredel <michael@bredel.at> Date: Sun, 12 Nov 2017 21:06:19 +0100 Subject: [PATCH 2/6] Added a section on Docker. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index c9122cd..b808074 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ This LaTeX-template might be used to write a bachelor or master thesis at the co * [Writing abstracts](#writing-abstracts) * [Adding content](#adding-content) * [Compiling the LaTeX source code](#compiling-the-latex-source-code) + * [Using Docker](#using-docker) * [Known issues](#known-issues) * [License](#license) @@ -164,6 +165,16 @@ generates a bz2-package file, which contains all the source files of your LaTeX $ make publish ``` +### Using Docker + +The h_da thesis template ships with a Dockerfile that creates a [Docker](https://www.docker.com) container used to compile the LaTeX code. This container is used by the Travis-CI infrastructure to compile the thesis template and check its integrity at every commit. To build the Docker container, you may type + +``` + $ docker build --label mbredel/thesis-template . +``` + +inside the root directory containing the Dockerfile. You may leverage the Docker container to compile the thesis template without installing the LaTeX build system on your computer. However, please note that additional steps are needed to create the PDF file and copy it from the Docker container to your host. + ## Known issues * The LaTeX template only supports bachelor theses (by default) From 58e524a022eab543591e3f47b4bb400891f36105 Mon Sep 17 00:00:00 2001 From: Michael Bredel <michael@bredel.at> Date: Sun, 12 Nov 2017 21:06:56 +0100 Subject: [PATCH 3/6] Corrected a small formatting issue. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b808074..d22368d 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ The default output of the LaTeX thesis template a two-sided style that also has ``` \documentclass[ openright,titlepage,numbers=noenddot,headinclude,% footinclude=true,cleardoublepage=empty,abstractoff,% - BCOR=5mm,paper=a4,fontsize=11pt, + BCOR=5mm,paper=a4,fontsize=11pt,% ngerman,american,% ]{scrreprt} ``` From 865846e077f64eca825536d1489da80de078f745 Mon Sep 17 00:00:00 2001 From: Michael Bredel <michael@bredel.at> Date: Sun, 12 Nov 2017 21:09:57 +0100 Subject: [PATCH 4/6] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d22368d..1cc27b3 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,19 @@ This LaTeX-template might be used to write a bachelor or master thesis at the co ## Table of contents * [Configuration](#configuration) - * [thesis.tex](#thesistex) + * [thesis.tex](#thesistex "Configuration options in the thesis.tex file") * [Two-sided vs. one-sided](#two-sided-vs-one-sided) - * [Bibliographies](#bibliographies) - * [Language](#language) + * [Bibliographies](#bibliographies "How to add additional bibligraphy files") + * [Language](#language "How to change the language of the document") * [Table of content, figures, tables, listings, and acronyms](#table-of-content-figures-tables-listings-and-acronyms) * [hdathesis-config.tex](#hdathesis-configtex) - * [Personal data](#personal-data) + * [Personal data](#personal-data "How to edit the personal data of the thesis") * [classicthesis-config.tex](#classicthesis-configtex) * [Usage](#usage) - * [Writing abstracts](#writing-abstracts) - * [Adding content](#adding-content) + * [Writing abstracts](#writing-abstracts "Adding abstracts to the thesis") + * [Adding content](#adding-content "Adding chapters to the thesis") * [Compiling the LaTeX source code](#compiling-the-latex-source-code) - * [Using Docker](#using-docker) + * [Using Docker](#using-docker "Using Docker for compiling the LaTeX code") * [Known issues](#known-issues) * [License](#license) From b99daded880a44c8d3631a277101052432928491 Mon Sep 17 00:00:00 2001 From: Benedict Reuschling <bsdbcr@users.noreply.github.com> Date: Tue, 28 Nov 2017 16:07:40 +0100 Subject: [PATCH 5/6] Update README.md Capitalize Computer Science department and spell Darmstadt correctly. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cc27b3..ac5d037 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # A thesis LaTeX-template -This LaTeX-template might be used to write a bachelor or master thesis at the computer science department at [h_da university of applied sciences](https://www.fbi.h-da.de/fbi.html "Hochschule Darmstadt, University of Applied Sciences") in Darstmadt. It is based on the fabulous ClassicThesis style template of [Andre Miedé](http://www.miede.de/ "Prof. Dr. Andre Miedé"). It is adapted to meet the current style guide for bachelor and master theses at the computer science department of h_da, as outlined in [Richtlinien zur Anfertigung der Bachelorarbeit](https://www.fbi.h-da.de/fileadmin/Inhalt/dokumente/Bachelor/BachelorProjekt/Richtlinien_Bachelorarbeit_070619.pdf) +This LaTeX-template might be used to write a bachelor or master thesis at the Computer Science department at [h_da University of Applied Sciences](https://www.fbi.h-da.de/fbi.html "Hochschule Darmstadt, University of Applied Sciences") in Darmstadt. It is based on the fabulous ClassicThesis style template of [Andre Miedé](http://www.miede.de/ "Prof. Dr. Andre Miedé"). It is adapted to meet the current style guide for bachelor and master theses at the Computer Science department of h_da, as outlined in [Richtlinien zur Anfertigung der Bachelorarbeit](https://www.fbi.h-da.de/fileadmin/Inhalt/dokumente/Bachelor/BachelorProjekt/Richtlinien_Bachelorarbeit_070619.pdf) ## Table of contents From ce93136162ac9d4de7580b0ec893f0de33fa3666 Mon Sep 17 00:00:00 2001 From: Michael Bredel <michael@bredel.at> Date: Tue, 28 Nov 2017 18:28:50 +0100 Subject: [PATCH 6/6] Added a statement on TeX-distributions to known issues. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ac5d037..a47de34 100644 --- a/README.md +++ b/README.md @@ -177,6 +177,8 @@ inside the root directory containing the Dockerfile. You may leverage the Docker ## Known issues +* The LaTeX template is tested using [TeXLive](https://www.tug.org/texlive/) which is available for Linux and Windows. + * It has not been tested for [MiKTeX](https://miktex.org/) and [MacTeX](https://www.tug.org/mactex/) yet. Any input on these LaTeX distributions is very welcome. * The LaTeX template only supports bachelor theses (by default) * The thesis only supports German and (American) English