Extended README. Added English version of README.

README.md

@@ -1,12 +1,33 @@
+See [English version](README_en.md).
+
 # ELTE IK TDK-dolgozat sablon
 
 A [tdk.tex](tdk.tex) és a belőle előálló [tdk.pdf](tdk.pdf) szolgál kiindulási példaként.
 A sablon alkalmazza a TDK-dolgozatokra vonatkozó formai előírásokat, valamint elkészíti a megadott metaadatok alapján a fedő- és a címlapot.
 A formai megkötések az ELTE Informatikai Karán, valamint az OTDK Informatika Tudományi Szekcióban megszokottak, de általánosan (szükség esetén megfelelő módosításokkal) alkalmazható más szekciók és más egyetemek TDK dolgozataihoz is.
 
-A sablon alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált, de előkészítetten (kikommentelve) tartalmazza a két oldalas nyomtatáshoz szükséges beállításokat. A sablon magyar és angol nyelvű dokumentumok elkészítését támogatja (ld. `\documentlang`).
+A sablon tartalmazza az egy és két oldalas nyomtatáshoz szükséges beállításokat is (ld. `twoside` paraméter), alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált. (Érdemes figyelembe venni, hogy 20-nál kevesebb lapszám kemény kötésben furcsán mutat, továbbá az ábrák könnyen átütnek az általános 80g/m<sup>2</sup> fénymásolópapíron).
+A sablon magyar és angol nyelvű dokumentumok elkészítését is támogatja (ld. `\documentlang` parancs).
+
+## Fordítás
+
+```bash
+# thesis.aux fájl generálása (PDF fájl még hibás hivatkozásokat fog tartalmazni)
+pdflatex thesis.pdf
+# Irodalomjegyzék generálása
+bibtex thesis
+# Jelölésjegyzék generálása (ha szükséges)
+makeindex -s nomencl.ist -t thesis.nlg -o thesis.nls thesis.nlo
+# Végleges PDF fájl generálása
+pdflatex thesis.pdf
+pdflatex thesis.pdf
+```
+
+**Megjegyzés:** az irodalomjegyzék változása esetén a `bibtex`, majd a `pdflatex` _kétszeri_ futtatása szükséges a helyes hivatkozások előállításához.
 
-## Fontosabb kiegészítő csomagok
+A fordításhoz tetszőleges fejlesztő környezet is használható (pl. [TexStudio](https://www.texstudio.org/)), ugyanezen utasítások kiadásával.
+
+## Fontosabb függőségi csomagok
 
 **Képkezelés:**
 * Minimális és maximális méret: [adjustbox](https://ctan.org/pkg/adjustbox)
@@ -17,17 +38,24 @@ A sablon alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált, de
 * Oszlopok és sorok egyesítése: [multirow](https://ctan.org/pkg/multirow)
 * Tördelhető táblázat: [longtable](https://ctan.org/pkg/longtable)
 * Cellatartalom vertikális igazítása: [array](https://ctan.org/pkg/array)
+* Többsoros cellák (sortörés): [makecell](https://ctan.org/pkg/makecell)
 
 **Felsorolások:**
 * Szoros térközű felsorolások: [paralist](https://ctan.org/pkg/paralist)
 
-**Egyebek:**
+**Matematika és algoritmusok:**
+* Matematikai formulák: [amsmath](https://ctan.org/pkg/amsmath)
+* Matematikai definíciók: [amsthm](https://ctan.org/pkg/amsthm)
+* Matematikai szimbólumok: [amsfonts](https://ctan.org/pkg/amsfonts)
+* Algoritmusok: [algorithmic](https://ctan.org/pkg/algorithms)
 * Kódblokkok: [listingsutf8](https://ctan.org/pkg/listingsutf8)
+
+**Egyebek:**
 * Teendők: [todonotes](https://ctan.org/pkg/todonotes)
 
-## Tételszerű bekezdések
+## Előre definiált tételszerű bekezdések
 
-* definition: Definíció
-* theorem: Tétel
-* remark: Emlékeztető
-* note: Megjegyzés
+* *definition*: Definíció
+* *theorem*: Tétel
+* *remark*: Emlékeztető
+* *note*: Megjegyzés

README_en.md

@@ -0,0 +1,59 @@
+# ELTE FI TDK thesis template
+
+The [tdk.tex](tdk.tex) and the produced [tdk.pdf](tdk.pdf) serves as an example of usage.
+This class template enforces the required formatting rules for TDK theses and generates the cover and title page given on the provided metadata.
+The formatting rules are defined to meet the requirements for TDK theses submitted at the Eötvös Loránd University, Faculty of Informatics. This also fits the formatting requirements of the Computer Science Section of the National Conference of Scientific Students' Associations (OTDK). With sufficient modifications the template should be usable for TDK theses at other national and faculty level sections, too.
+
+The template contains configuration both for single and double sided printing (see `twoside` option), by default it is set to the recommended single side format.
+The template supports producing both Hungarian and English theses, which can be easily controlled (see `\documentlang` command).
+
+## Compilation
+
+```bash
+# Generate thesis.aux file (PDF file contains incorrect references yet)
+pdflatex thesis.pdf
+# Generate bibliography
+bibtex thesis
+# Generate nomenclature (optional)
+makeindex -s nomencl.ist -t thesis.nlg -o thesis.nls thesis.nlo
+# Generate final PDF file
+pdflatex thesis.pdf
+pdflatex thesis.pdf
+```
+
+**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.
+
+## Required packages (without completeness)
+
+**Image handling:**
+* Minimal and maximal size: [adjustbox](https://ctan.org/pkg/adjustbox)
+* Subfigures: [subfigure](https://ctan.org/pkg/subfigure)
+* Rotation: [rotating](https://ctan.org/pkg/rotating)
+
+**Table management:**
+* Multirow and multicolumn support: [multirow](https://ctan.org/pkg/multirow)
+* Breakable tables: [longtable](https://ctan.org/pkg/longtable)
+* Vertical positioning of cells: [array](https://ctan.org/pkg/array)
+* Multiline cells (line breaks): [makecell](https://ctan.org/pkg/makecell)
+
+**Lists:**
+* Lists with narrow spacing: [paralist](https://ctan.org/pkg/paralist)
+
+**Mathematical formulas and algorithms:**
+* Mathematical formulas: [amsmath](https://ctan.org/pkg/amsmath)
+* Mathematical definitions: [amsthm](https://ctan.org/pkg/amsthm)
+* Mathematical symbols: [amsfonts](https://ctan.org/pkg/amsfonts)
+* Algorithms: [algorithmic](https://ctan.org/pkg/algorithms)
+* Code blocks: [listingsutf8](https://ctan.org/pkg/listingsutf8)
+
+**Miscellaneous:**
+* Todos: [todonotes](https://ctan.org/pkg/todonotes)
+
+## Predefined theorem-like environments
+
+* *definition*
+* *theorem*
+* *remark*
+* *note*