Skip to content

Commit 138a1fb

Browse files
author
3986209
committed
Expanding the readme and cleaning the documentation
1 parent 63ccd1d commit 138a1fb

File tree

8 files changed

+60
-6373
lines changed

8 files changed

+60
-6373
lines changed

.DS_Store

0 Bytes
Binary file not shown.

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
## Folder view configuration files
2+
.DS_Store
3+
Desktop.ini
4+
5+
## Thumbnail cache files
6+
._*
7+
Thumbs.db
8+
9+
## Files that might appear on external disks
10+
.Spotlight-V100
11+
.Trashes
12+
13+
## Compiled Python files
14+
*.pyc
15+
16+
## Compiled C++ files
17+
*.out
18+
19+
## Application specific files
20+
venv
21+
node_modules
22+
.sass-cache
23+
24+
125
## Core latex/pdflatex auxiliary files:
226
*.aux
327
*.lof

Biblio/.DS_Store

-6 KB
Binary file not shown.

Biblio/IEEEtran.cls

Lines changed: 0 additions & 6347 deletions
This file was deleted.

MainMatter/.DS_Store

0 Bytes
Binary file not shown.

MainMatter/paper1/.DS_Store

0 Bytes
Binary file not shown.
File renamed without changes.

README.md

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Utrecht University dissertation template
22

3-
Version 0.2.0
3+
Version 0.2.1
44

5-
This is a Utrecht University dissertation template for LaTeX. While it is based around the TU Delft template, it should follow the required content and textual obligations as provided in the doctoral degree regulations and the 'aanwijzingen voor promovendi'. If any issues are found, please let us know!
5+
This is a Utrecht University dissertation template for LaTeX put together by Laurens Stoop. While it is based around the TU Delft template, it should follow the required content and textual obligations as provided in the doctoral degree regulations and the 'aanwijzingen voor promovendi'.
66

7-
It is designed to work with all versions of LaTeX, but if you want to adhere to the TU Delft house
8-
style, you need to use XeLaTeX, as it supports TrueType and OpenType fonts.
7+
It is designed to work with all versions of LaTeX, but if you want to adhere to the TU Delft housestyle, you need to use XeLaTeX, as it supports TrueType and OpenType fonts.
98

9+
We welcome all input and any suggestions or examples using this template.
1010

1111
## Using the template
1212

@@ -17,38 +17,48 @@ The document can be compiled with
1717
pdflatex main
1818
pdflatex main
1919

20-
Or by selecting the 'pdfLaTeX' and 'Biber' options in your favorite TeX editing
21-
program, respectively. Note that you have to run bibtex for every chapter.
20+
Or by selecting the 'pdfLaTeX' and 'Biber' options in your favourite TeX editing program, respectively. Note that you have to run biber for every chapter.
2221

2322
A sample document, as well as documentation for template options, can be found
24-
in example.pdf.
23+
in main.pdf.
2524

26-
## Project organization
25+
## Project organisation
26+
27+
A description of the project organisation is provided below. The required, often included and optional sections are also labeled here (as well as within main.tex).
28+
29+
As this is an ongoing project, the works in progress (WIP) are explicitly listed.
2730

2831
```
2932
.
3033
├── .gitignore
3134
├── CITATION.md
3235
├── LICENSE.md
3336
├── README.md
34-
├── dissertation.cls <- Class description and general style definition
35-
├── stylesheet.tex <- Packages and some style definitions
36-
├── main.tex <- Main LaTeX document, use this to (de-)activate chapters and parts
37-
├── main.pdf <- Compiled disseration
38-
├── fonts <- Set of fonts to use within the dissertation
39-
├── FrontMatter <- Contains all .tex files for content before the introduction
40-
│ ├── cover.tex <- Styling of the cover content
41-
│ ├── Cover <- Contains cover images
42-
│ ├── title.tex <- Title page content and styling
43-
│ ├── Logos <- Contains all logos used
44-
│ ├── acronyms.tex <- Definition of acronyms used
45-
│ └── preface.tex <- Optional opening word
46-
├── MainMatter <- Contains all .tex files for the content from introduction to conclusion
47-
│ ├── manuscript <-
48-
│   └── reports <-
49-
└── BackMatter <- Contains all .tex files for content after the conclusion
50-
├── figures <-
51-
   └── output <-
37+
├── dissertation.cls <- Class description and general style definition (WIP)
38+
├── stylesheet.tex <- Packages and some style definitions (WIP)
39+
├── main.tex <- Main .tex document, use this to (de-)activate chapters and parts
40+
├── main.pdf <- Compiled disseration
41+
├── fonts <- Set of fonts to use within the dissertation
42+
├── FrontMatter <- Contains all .tex files for content before the introduction
43+
│ ├── cover.tex <- Styling of the cover content
44+
│ ├── Cover <- Contains cover images
45+
│ ├── title.tex <- Title page content and styling (required)
46+
│ ├── Logos <- Contains all logos used
47+
│ ├── acronyms.tex <- Definition of acronyms used (often included)
48+
│ └── preface.tex <- Optional opening word (optional)
49+
├── MainMatter <- Contains all .tex files for the content from introduction to conclusion
50+
│ ├── introduction.tex <- Introduction .tex file (required)
51+
│ ├── conclusions.tex <- Conclusion .tex file (required)
52+
│   └── paper1 <- Contains the .tex and .bib file (paper1-main) and Figures folder
53+
└── BackMatter <- Contains all .tex files for content after the conclusion
54+
├── epilogue.tex <- Epilogue (optional)
55+
├── appendix-example.tex <- Example of appendix of a MainMatter paper/chapter
56+
├── summary.tex <- English summary (often included)
57+
├── samenvatting.tex <- Dutch samenvatting (required)
58+
├── publications.tex <- Listing method for published works (required, can be part of introduction)
59+
├── acknowledgements.tex <- Ackns. or Dankwoord (often included)
60+
├── cv.tex <- CV or about the author (required)
61+
   └── backcover.tex <- Styling of the back cover content
5262
5363
```
5464

0 commit comments

Comments
 (0)