[Doc] update

2026-08-09 03:49:26 +02:00
parent f5553f0b65
commit 50631db9c1
1 changed files with 57 additions and 11 deletions
@@ -1,20 +1,66 @@
-# Radionice
+# Radionice – Workshop Slide Decks

-Usage: `make`
+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.

-## Dependecies:
-
-### For Debian:
+## Quick start

 ```bash
-sudo apt update
-sudo apt install pandoc
-sudo apt install tikzit
+# List available make targets
+make
+
+# Build all PDFs (default theme: Warsaw Beamer)
+make pdfs
+
+# Remove generated PDFs
+make clean
 ```

-### For Arch:
+The `Makefile` uses `pandoc` with the `beamer` template.  If you prefer a different theme, edit the `pandoc` options in the `Makefile`.

-```bash
-pacman -Sy pandoc texlive-binextra texlive-pictures texlive-latexrecommended texlive-fontsrecommended
+## 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.