Commit 068069a5 authored by burcharr's avatar burcharr 💬
Browse files

Update README.md

parent da27d234
......@@ -2,24 +2,24 @@
A thesis template in order to write a thesis in Markdown / Latex using Pandoc Thesis.
Based on [pandoc-thesis](https://github.com/cagix/pandoc-thesis). If my Instructions are unclear, maybe their repo can help!
## Prerequisites
- docker
- TODO? anything else?
## Instructions:
### First steps
1. Make sure all prerequisites are installed and you can run the generation (using `make` in this folder)
2. 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.
3. Edit the contents of `md/metadata.yaml` by filling in your name, thesis title, due date etc. (This is also where your abstract goes)
1. Make sure all prerequisites are installed
2. Run `make docker` (can take some time)
3. Make sure that you can run the generation (using `make` in this folder)
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.
### Adding, Removing or Renaming markdown files
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment