67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
# Radionice – Workshop Slide Decks
|
||
|
||
This repository contains a collection of slide decks written in Markdown and compiled to PDFs (and optionally handouts) for a variety of workshops. The slides are organised under the `slides/` directory – each sub‑folder represents a different workshop and contains a single `.md` file along with any required images or resources.
|
||
|
||
## Quick start
|
||
|
||
```bash
|
||
# List available make targets
|
||
make
|
||
|
||
# Build all PDFs (default theme: Warsaw Beamer)
|
||
make pdfs
|
||
|
||
# Remove generated PDFs
|
||
make clean
|
||
```
|
||
|
||
The `Makefile` uses `pandoc` with the `beamer` template. If you prefer a different theme, edit the `pandoc` options in the `Makefile`.
|
||
|
||
## Directory layout
|
||
|
||
```
|
||
slides/
|
||
├─ 3Dprint
|
||
│ ├─ 3DPrint.md
|
||
│ └─ pics/…
|
||
├─ algebragrupe
|
||
│ └─ algebragrupe.md
|
||
├─ ansible
|
||
│ ├─ ansible.md
|
||
│ └─ examples/…
|
||
└─ … (other workshops)
|
||
```
|
||
|
||
Each workshop folder contains:
|
||
* A single Markdown file (e.g. `ansible.md`).
|
||
* A `pics/` or `examples/` directory with images or code snippets.
|
||
|
||
## Building requirements
|
||
|
||
| Tool | Purpose | Debian | Arch |
|
||
|------|---------|--------|------|
|
||
| `pandoc` | Markdown → PDF | `sudo apt install pandoc` | `pacman -S pandoc` |
|
||
| `tikzit` | Optional diagram support | `sudo apt install tikzit` | `pacman -S tikzit` |
|
||
| `texlive-*` | LaTeX backend for beamer | `sudo apt install texlive-binextra texlive-pictures texlive-latexrecommended texlive-fontsrecommended` | `pacman -Sy texlive-core texlive-latexrecommended texlive-fontsrecommended` |
|
||
|
||
You can also install the full `texlive` bundle if you prefer.
|
||
|
||
## How to create a new slide deck
|
||
|
||
1. Create a folder under `slides/` with a descriptive name.
|
||
2. Add a `YourWorkshop.md` file with the Markdown content.
|
||
3. Add any images or auxiliary files into a `pics/` or `examples/` sub‑folder.
|
||
4. Run `make` to see the new target or `make pdfs` to build PDFs.
|
||
|
||
## Contributing
|
||
|
||
Pull requests are welcome. Please keep Markdown styling consistent and ensure all images are correctly linked. If you add a new workshop, update the `README` section above if necessary.
|
||
|
||
## License
|
||
|
||
This repository is licensed under the [GPL‑v3](LICENSE).
|
||
|
||
---
|
||
|
||
© 2024 Radionice. All rights reserved.
|