Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
jdupak committed Feb 14, 2025
1 parent 21a0fc6 commit ccfec1f
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# PDV
These steps describe the build process of the slides on Linux or Windows Subsystem for Linux.

The repository with the tutorial sources now lives at
https://github.com/aicenter/PDV-tutorials

You can also edit the slides in Overleaf at https://www.overleaf.com/project/62055881c2d6c95f912de323

The repository with the tutorial sources now lives at https://github.com/aicenter/PDV-tutorials

**Notice**: Parallel and distributed labs are not using different format.

## What should I do after cloning this repository?
From the root of the repository, load the git aliases to the build scripts:
Expand All @@ -15,6 +11,9 @@ From the root of the repository, load the git aliases to the build scripts:
Note: `..` is required, as it is relative from the .git folder in the project.

## Requirements
For Typst slides:
- [Typst](https://github.com/typst/typst)

For beamer slides:
- texlive for compiling tex files: `sudo apt-get install texlive texlive-latex-extra texlive-luatex texlive-fonts-extra texlive-lang-czechslovak`
- pygments for syntax higlighting in slides: `sudo apt-get install python-pygments`
Expand All @@ -23,8 +22,16 @@ For beamer slides:
For editing graphics:
- IPE editor: http://ipe.otfried.org/

## Editing

You can edit the Beamer slides in Overleaf at https://www.overleaf.com/project/62055881c2d6c95f912de323

For typst slides it is recommended to use VS Code with [Tinymist Typst extension](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist) with close to instant preview.

You can also use online app similar to overleaf [https://typst.app/](https://typst.app/) and upload the directory there. However sync with git is a paid feature.

## Usage
### Compiling the beamer slides
### Compiling slides
1. cd to the tutorial directory, e.g. `cd ./09`
2. Having the aliases set, run the compile script with `git make`

Expand All @@ -44,6 +51,9 @@ done
Go to https://sites.google.com/a/fel.cvut.cz/quiz/, your cvut googleapps account has to be added to the PDV course.

### Online feedback form

**Deprecated**: Matej does not want to use the form any more.

There is one form for all tutorials, it is saved in the G-drive of the course. Use the `\framefeedback{}` command to include a slide. Don't forget to activate the form before classes and lock it afterwards.

## Github Actions Automated Compilation and Release
Expand Down

0 comments on commit ccfec1f

Please sign in to comment.