SLDS Lecture Service Companion • lese

This project has two goals:

Provide common assets needed for all lectures, once, to keep them in sync.
Check slides in lecture repositories (do they compile, are the PDFs up to date?).

(It also happens to be an R package lese you can install with many convenience functions)

For 1), all required files should live in ./service/ with the correct folder structure such that one can simply copy the files from this directory “on top” of an existing lecture, e.g.:

rsync -r lecture_service/service/ lecture_i2ml/

This is wrapped with the script in each lecture’s ./scripts/update-service.sh so within e.g. lecture_i2ml you can run

bash scripts/update-service.sh

Any changes proposed to service files covered by ./service (particularly the style folder) will first need to be made in this repo and then dependant lecture repos can be updated accordingly.

Overview

The assumed directory structure once lecture repositories where cloned (or downloaded) looks like this:

lecture_service
├── lecture_advml
├── lecture_i2ml
├── lecture_sl
├── [...]
├── Makefile
├── R
├── scripts
├── service
└── [...]

You can either manually git clone lecture repos or use make clone

Note that the text file include_lectures is used to globally keep track of the relevant lecture repos, so if you only intend to work on lecture_advml you could set it to only contain lecture_advml and subsequent make commands and other functions will be limited on scope to this lecture. By default it contains all lectures currently hosted at slds-lmu/.

SLDS Lecture Service (lese)

Overview