]> mj.ucw.cz Git - diplomky.git/commitdiff
An English version of README
authorMartin Mares <mj@ucw.cz>
Thu, 18 Jul 2019 08:14:26 +0000 (10:14 +0200)
committerMartin Mares <mj@ucw.cz>
Thu, 18 Jul 2019 08:14:26 +0000 (10:14 +0200)
README
README.en [new file with mode: 0644]
TODO

diff --git a/README b/README
index 1ca6113e740e4440eb1cd6b66bba357514320790..e44a74db1dd0c44add2916f2bdb2f18029ac7973 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,7 @@ Povinné náležitosti úpravy bakalářských prací jsou dány směrnicemi dě
 č. 4/2019, 1/2015 a 7/2016 a opatřením rektora č. 72/2017. Mimo to existují
 ještě další doporučení -- ta najdete v souboru vzor.pdf. Tento formát pro LaTeX
 se jimi řídí a snaží se důležité věci připomínat komentáři. Přesto si ale celá
-pravidla přečtěte -- například úprava desek práce je popsána pouze tam.
+pravidla přečtěte.
 
 Pokud LaTeX ještě neznáte, na webu naleznete mnoho úvodních textů.
 Nám se nejvíce osvědčil http://en.wikibooks.org/wiki/LaTeX.
diff --git a/README.en b/README.en
new file mode 100644 (file)
index 0000000..904dbeb
--- /dev/null
+++ b/README.en
@@ -0,0 +1,57 @@
+A template for typesetting a bachelor thesis at MFF UK in LaTeX
+
+Authors:
+
+       Martin Mareš <mj@ucw.cz> -- the current maintainer
+       Arnošt Komárek <komarek@karlin.mff.cuni.cz>
+       Michal Kulich <kulich@karlin.mff.cuni.cz>
+
+This package can be freely distributed, used, and modified.
+If you have any bug report or comment, please tell us.
+--------------------------------------------------------------------------------
+
+There are two versions of the template -- Czech (directory "cs")
+and English ("en").
+
+Requirements on formatting of bachelor theses are given by Dean's directives
+4/2019, 1/2015, and 7/2016, and by the Rector's directive 72/2017. Other
+guidelines can be found in the example.pdf file. This LaTeX template follows
+the directives; it also tries to emphasize important points in comments. Still,
+we advise you to read the complete rules.
+
+If you are not familiar with LaTeX yet, you can find numerous tutorials on
+the Web. One example we like is http://en.wikibooks.org/wiki/LaTeX.
+
+Basic typographical settings can be found in thesis.tex, which also refers
+to all other files containing individual chapters. Please read the main file
+carefully and fill in the thesis name, author, and other identifiers. You also
+need to update the meta-data file thesis.xmpdata.
+
+The Czech version contains several example chapters with hints on typesetting
+of common expressions. There are not available in the English version yet,
+sorry.
+
+The electronic version of your thesis must be submitted to SIS. It must
+conform to the PDF/A-1a or -2u standard. This template produces PDF/A-2u
+using the pdfx LaTeX package (https://www.ctan.org/tex-archive/macros/latex/contrib/pdfx).
+Please note that many installations of TeX have this package either obsolete
+or broken. So we advise to download the current version of the package and
+unpack it to tex/pdfx/.
+
+Our FAQ on producing PDF/A is currently available in Czech only, but if you
+encounter any problems, please ask Martin Mareš for advice.
+
+If you are using Windows, beware that MikTeX contains old versions of some
+(mostly mathematical) fonts, which leads to improper PDF/A output. We have
+much better experience with the TeXlive distribution.
+
+If you are using a UNIX system, you might want to use our example Makefile --
+just run "make" to process all files by TeX.
+
+You can also run TeX manually. In this case, you should use pdfTeX and also
+BibTeX for generating bibliography. (The usual order is: pdflatex, bibtex,
+and then pdflatex twice to get cross-references right. Alternatively, you
+can use latexmk.)
+
+The current development version of this template and other hints on writing
+theses can be found at http://mj.ucw.cz/vyuka/bc/.
diff --git a/TODO b/TODO
index 6048a33eacdba70e66e7db54052052bf78381d3f..a20d0b08e9f70c766e2cf33e19db6a4cbf04bad9 100644 (file)
--- a/TODO
+++ b/TODO
@@ -4,8 +4,6 @@ Jaký typ PDFkových anotací produkuje hyperref? Někdy prohlížeče
 rámečky kolem odkazů neukazují, jindy ne, a například linuxové lp
 je pak vytiskne.
 
-Anglické README.
-
 Pojmenované věty mají nepěknou tučnou tečku za netučným jménem.
 Za to ovšem může balíček amsthm a není jasné, jak mu v tom zabránit.
 Pomocí \newtheoremstyle sice jde předefinovat, jak se tečka sází,