README.md 2.89 KB
Newer Older
Yannic Schröder committed
1 2 3 4 5 6 7 8 9 10
# IBR Thesis Framework

Welcome to the IBR thesis framework!

So, you are going the write a thesis at our institute. This is a very good choice! To make your life easier we have prepared a basic structure aka. framework to put your written text into. You already found the README for this framework, good job!

## Steps to write your thesis

This manual is for students who have none or only very basic knowledge of LaTeX. If you know what you are doing, you do not have to adhere to this manual. But then: Proceed at your own risk!

11 12 13 14 15 16 17 18
### Install LaTeX

Install TeX Live (https://www.tug.org/texlive/) or MiKTeX (https://miktex.org/) on your computer.

### Install tubslatex

The framework is based on the tubslatex corporate design templates for LaTeX by Enrico Jörns. Install tubslatex from the project's website: http://tubslatex.ejoerns.de/

19
### Fork this repository
Yannic Schröder committed
20

21 22 23 24
You should fork the repository to have your own copy inside Gitlab. Press the `Fork` button of this project or click here: [Fork me!](https://gitlab.ibr.cs.tu-bs.de/yschroed/thesis_framework/forks/new)

You can then clone your fork onto your computer via git by running something like this command:

25
`git clone git@gitlab.ibr.cs.tu-bs.de:[YOUR_NAME_HERE]/thesis_framework.git`
Yannic Schröder committed
26 27 28

This clones this repository into the folder `thesis_framework`. You can write your thesis right in that directory. As this is already a git repository you can track your work on your text with it. We strongly advice you to do so: Commit often!

29 30
Push your repository regularly (at least once a day) to our Gitlab server. Our server is backed up every night to a local backup and into the Gauß-IT-Zentrum. When pushing to our Gitlab you will (almost) never loose your progress due to a faulty computer!

Yannic Schröder committed
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 56 57 58 59 60 61
### Configuration

You find the basic configuration of your thesis in the file `configuration.tex`. Check it and change it to suit your needs.

### Expose/Proposal

The main file to run `pdflatex` on to build the expose is `expose/expose.tex`.

### Thesis

The main file to run `pdflatex` on to build the thesis is `thesis/thesis.tex`.

#### Abstract

Put your abstract into the file `thesis/abstract.tex`. If you write your thesis in german you need a german "Zusammenfassung" and an english "Abstract". If you write it in english. You only need the english abstract.

#### Chapters

Make a file for each chapter of your thesis in `thesis/chapters/`. This makes organization of your text easier. There are some examples in there already.

### Bibliography

Put your bibtex items into `bibliography.bib`. This file is shared between the expose and the thesis.

### Images

Put all images in the folder called `images`. You can reuse images from your expose in your thesis.

## The `lib` folder

This folder contains a lot of LaTeX magic that you normally do not need to touch if we did our job on the framework well. If you find errors though, feel free to modify it. Send us a pull request if you fix a bug!