diff --git a/README.md b/README.md index dd7d14e..84ee892 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,46 @@ LaTeX template for writing your thesis. It is adapted to the common needs in Inf ## Getting started +These are the files relevant to your thesis: + +``` +. +├── images +│ └── sample.png +├── sections +│ ├── abstract.tex +│ ├── acknowledgement.tex +│ ├── acronyms.tex +│ ├── appendix.tex +│ ├── background.tex +│ ├── conclusion.tex +│ ├── contents.tex +│ ├── declaration.tex +│ ├── discussion.tex +│ ├── introduction.tex +│ ├── method.tex +│ └── results.tex +├── bibliography.bib +├── config.tex +├── preamble.tex +├── thesis.tex +└── titlepage.tex +``` + ++ `images/`: subdirectory for graphics ++ `sections/`: subdirectory for all the sections of your thesis ++ `bibliography.bib`: contains your references ++ `config.tex`: allows to specify your information for the front matter ++ `preamble.tex`: LaTeX packages used in this project ++ `thesis.tex`: root file for this document – **this is the one you will compile** ++ `titlepage.tex`: the title page + +## Compiling the document + + Install [LaTeX](https://latex-project.org/). + On Linux, you may need to install `ttf-mscorefonts-installer` to use the Times New Roman font. + Adjust the variables set in [`config.tex`](config.tex). ++ Compile [`thesis.tex`](thesis.tex) using either your LaTeX editor or the command line. Make sure to specify LuaLaTeX and Biber as your compilers. ```sh lualatex thesis.tex