You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Important notice:
21
21
22
22
### Details on the `tex` version
23
23
24
-
The `tex` version of this template can be compiled using [latexmk](https://mg.readthedocs.io/latexmk.html) ([version 4.74. or higher](https://github.com/aubertc/au_ccs_dissertation_template/issues/1)), by running
24
+
The `tex` version of this template can be compiled using [latexmk](https://mg.readthedocs.io/latexmk.html), by running
25
25
26
26
latexmk -pdf -xelatex main.tex
27
27
@@ -36,16 +36,31 @@ Start by looking for
36
36
37
37
and replace the values of the commands from `\yourtitle{…}` to `\yourdate{…}`, uncommenting `\togglefalse{ms}` and commenting `\toggletrue{ms}` if you are a PhD student.
38
38
39
+
40
+
Requirements
41
+
~
42
+
- [LaTeX](https://www.latex-project.org/get/),
43
+
- [latexmk](https://mg.readthedocs.io/latexmk.html) (it is possible that it is already part of your LaTeX installation).
44
+
39
45
### Details on the markdown version
40
46
41
47
The markdown version of this template can be compiled using [pandoc](https://pandoc.org/), by running
42
48
43
49
make
44
50
45
-
in the md_version folder. You will need [Cygwin](http://www.cygwin.com/) or [some alternative](https://stackoverflow.com/q/2532234) to use this command on Windows, but can also simply open the [makefile](md_version/makefile) file to "extract" the pandoc options needed to compile properly this document.
51
+
in the md_version folder.
46
52
47
53
Start by editing the file info/info.tex with your information.
48
54
55
+
Requirements
56
+
~
57
+
- The ability to execute [makefile](https://en.wikipedia.org/wiki/Makefile)^[You can also simply open the [makefile](md_version/makefile) file to "extract" the pandoc options needed to compile properly this document.] (e.g., a UNIX system, a system with [Cygwin](https://en.wikipedia.org/wiki/Cygwin), or [some other trick](https://stackoverflow.com/q/2532234/)),
58
+
- the latest version of [pandoc](https://pandoc.org/installing.html),
59
+
- [LaTeX](https://www.latex-project.org/get/) (refer to the instructions on the [pandoc installation page](https://pandoc.org/installing.html] or at <https://tex.stackexchange.com/q/1092>^[It is probaby better to install a minimal installation, and then to fetch the missing packages one by one, using e.g. `/usr/local/texlive/2021/bin/x86_64-linux/tlmgr install environ` for the `environ` package.]),
60
+
- [latexmk](https://mg.readthedocs.io/latexmk.html) ([version 4.74. or higher](https://github.com/aubertc/au_ccs_dissertation_template/issues/1), it is possible that it is already part of your LaTeX installation),
61
+
- [entr](https://github.com/eradman/entr) if you want to use the command `make watch` that automatically re-compile your source when it is saved.
62
+
63
+
49
64
## Additional Information
50
65
51
66
Please, refer to the [Thesis/PhD Dissertation Preparation Booklet](https://www.augusta.edu/gradschool/documents/thesis-dissertation-preparation-booklet.pdf) from the graduate school and the University Libraries for additional information, tips and advises.
0 commit comments