summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/elteiktdk/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/elteiktdk/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/elteiktdk/README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/Master/texmf-dist/doc/latex/elteiktdk/README.md b/Master/texmf-dist/doc/latex/elteiktdk/README.md
index fc5c76f0a15..bb64bd061e9 100644
--- a/Master/texmf-dist/doc/latex/elteiktdk/README.md
+++ b/Master/texmf-dist/doc/latex/elteiktdk/README.md
@@ -1,3 +1,9 @@
+![CI status](https://github.com/mcserep/elteiktdk/workflows/Build%20LaTeX%20document/badge.svg)
+[![Overleaf template](https://img.shields.io/badge/Overleaf-TDK%20Thesis%20Template%20(ELTE%20FI)-brightgreen)](https://www.overleaf.com/latex/templates/tdk-thesis-template-elte-fi/mxnndxkmdmkd)
+
+
+See [Hungarian version](README_hu.md).
+
# ELTE FI TDK thesis template
The [elteiktdk_en.tex](elteiktdk_en.tex) and the produced [elteiktdk_en.pdf](elteiktdk_en.pdf) serves as an example of usage.
@@ -14,17 +20,14 @@ The template supports producing both Hungarian and English theses, which can be
# (PDF file contains incorrect references yet)
pdflatex elteiktdk_en.tex
# Generate bibliography
-bibtex elteiktdk
+biber elteiktdk_en
# Generate nomenclature (optional)
makeindex -s nomencl.ist -t elteiktdk_en.nlg \
-o elteiktdk_en.nls elteiktdk_en.nlo
# Generate final PDF file
pdflatex elteiktdk_en.tex
-pdflatex elteiktdk_en.tex
```
-**Note:** in case the bibliography changes, executing `bibtex`, then `pdflatex` _twice_ is required to generate to correct references in the PDF output.
-
Compilation might be carried out through a preferred IDE (e.g. [TexStudio](https://www.texstudio.org/)), given the same commands should be executed.
## Syntax highlighting of code blocks
@@ -32,6 +35,11 @@ Compilation might be carried out through a preferred IDE (e.g. [TexStudio](https
The minted package is also supported for syntax highlighting, for details see the [documentation](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
For its usage the Python interpreter and the `Pygments` package must be installed as a prerequisite, then you should uncomment its loading at the beginning of `elteiktdk_en.tex`.
+## Overleaf
+
+*Overleaf* is a free, easy to use online, collaborative LaTeX editor; similar like e.g. Google Docs, but for LateX documents.
+You can also find the latest release of this thesis template [on Overleaf](https://www.overleaf.com/latex/templates/tdk-thesis-template-elte-fi/mxnndxkmdmkd).
+
## Required packages (without completeness)
**Image handling:**