Commit e3e1a843 authored by Sushil BHATTACHARJEE's avatar Sushil BHATTACHARJEE

updated README

parent 6a50b5a6
Pipeline #25608 failed with stage
in 2 seconds
......@@ -13,50 +13,4 @@ Slides of the lab:
[Lab material](./lab/lab.md)
## LaTeX Beamer slides with pandoc
We are using [pandoc](https://pandoc.org) to convert simple .md files into latex beamer.
Please refer to the lecture example (git@gitlab.idiap.ch:master-biometrics/lecture-example.git) for more details.
## Setting up
**You need to refer** to the same section the lecture example (git@gitlab.idiap.ch:master-biometrics/lecture-example.git) for more details.
For a quick setup just do
```sh
$ git clone git@gitlab.idiap.ch:master-biometrics/graphics.git
$ git clone git@gitlab.idiap.ch:master-biometrics/<this-lab>.git
$ cd <this-lab>
$ rm -rf graphics
$ ln -s ../graphics .
```
## Building the slides
Proceed in 2 steps when working on the slides in .md files:
1. edit only the .md files
2. check if it compiles
To compile
* You can just compile the slides of one md file:
```sh
$ make 01_section1.pdf
```
***notice the name of the make target is the filename with a `.pdf` extension***
* Or your can compile all the slides (`lab.pdf`) that merges all sections into it.
```sh
$ make
```
***The input `.md` files are sorted before inclusion, so ensure that the name sorting works fine before building the whole document.***
* You can use flag `-B` with make to force recompilation if necessary. Otherwise, our Makefile is set to detect changes automatically.
```sh
$ make -B
```
It results in a ``lab.pdf`` file.
**Please don't git add/commit/push this file nor any other PDF by-product. They are git-ignored by default.**
Markdown is supported
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