Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GuriTheoChem committed Mar 11, 2024
1 parent f97e1bc commit 3b473a4
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,27 @@ Read this [article](https://docs.github.com/en/repositories/creating-and-managin

## Building the PDF of the Thesis

- To build the pdf of the Thesis, execute the following.
- To build the pdf of the Thesis, execute the following:

```{bash}
```bash
latexmk -pdf -pdflatex="pdflatex -interaction=nonstopmode -synctex=1" -use-make -output-directory=build src/main.tex
```

> Note: I use `latexmk` for an automated compilation of this template pdf as it has cross-references(bibliography, table of contents). I do not test any other compilers. Please read more about choosing a compiler on this overleaf [article](https://www.overleaf.com/learn/latex/Choosing_a_LaTeX_Compiler#TeX_distributions).

- If you choose exclude Index from your final pdf, you can simply execute the following:

```bash
latexmk -pdf -output-directory=build src/main.tex
```

This builds the pdf in the `build/` directory under the file name `main.pdf`.
> Note: Comment out `\usepackage{makeidx}` and `\makeindex` in [preamble.tex](src/contents/latex_doc_preamble/preamble.tex). Comment out `\printindex` in [main.tex](src/main.tex).

> Note: I use `latexmk` for an automated compilation of this template pdf as it has cross-references(bibliography, table of contents). I do not test any other compilers. Please read more about choosing a compiler on this overleaf [article](https://www.overleaf.com/learn/latex/Choosing_a_LaTeX_Compiler#TeX_distributions).
- The pdf named `main.pdf` is built in the `build/` folder.

- To build the plots:

```{bash}
```bash
python3 src/generate_plots.py
```

Expand Down

0 comments on commit 3b473a4

Please sign in to comment.