README.md 2.1 KB
Newer Older
burcharr's avatar
burcharr committed
1
2
# thesis_template

burcharr's avatar
burcharr committed
3
4
A thesis template in order to write a thesis in Markdown / Latex using Pandoc Thesis. 

burcharr's avatar
burcharr committed
5
Based on [pandoc-thesis](https://github.com/cagix/pandoc-thesis). If my Instructions are unclear, maybe their repo can help!
burcharr's avatar
burcharr committed
6

burcharr's avatar
burcharr committed
7
8
You can create a (private, if desired) fork of this repo and write your thesis with it. 

burcharr's avatar
burcharr committed
9
10
11
12
13
14
15
16

## Prerequisites

- docker


## Instructions:

17
18

### First steps
burcharr's avatar
burcharr committed
19
20
1. Make sure all prerequisites are installed
2. Run `make docker` (can take some time)
burcharr's avatar
burcharr committed
21
3. Make sure that you can run the generation (using `make` in this folder, if it does not work, you may have to manually set WORKDIR in the Makefile)
burcharr's avatar
burcharr committed
22
23
24
4. Edit the files to your liking, a skeleton is layed out but it can be modified as you wish. I propose using one markdown file per chapter.
5. Edit the contents of `md/metadata.yaml` by filling in your name, thesis title, due date etc. (This is also where your abstract goes)
6. Profit.
burcharr's avatar
burcharr committed
25
26

### Adding, Removing or Renaming markdown files
27

burcharr's avatar
burcharr committed
28
The Markdown files are all stored in `md/`. You can edit and rename them there, or create new ones. In order to add them, just enter them into the Makefile. 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

### Mixing latex and markdown syntax, using the template

You can freely use markdown and latex syntax at the same time! E.g. enumerations with 1. 2. 3. instead of the latex begin list etc.

- You can mix latex and markdown references (latex: \label{xy} \ref{xy}, md: #xy @xy)

- Citations with @citekey (citekey as in references.bib)

- Inline math with `$x = 4$`

- Images can be included with markdown or with latex to your liking

- Latex commands can be added where ever you want

- For images and tables, you can use the provided folders.

- Latex includes (of packages) must be added at the beginning of titelpage.tex

#### Building, cleaning

- use `make` to generate the thesis, into `thesis.pdf`

- use `make distclean` to clean up (delete) all generated files

- sometimes, if only "external" files have changed, one must clean before a new pdf is generated, as the changes are not detected by make.

burcharr's avatar
burcharr committed
56
57
#### Misc
- there is the script `git_all.sh`, which will add, commit and push all (no guarantee) changes to gitlab