]> git.ipfire.org Git - talks.git/commitdiff
Add README.md & COPYING
authorMichael Tremer <michael.tremer@ipfire.org>
Wed, 18 Feb 2026 17:31:53 +0000 (17:31 +0000)
committerMichael Tremer <michael.tremer@ipfire.org>
Wed, 18 Feb 2026 17:31:53 +0000 (17:31 +0000)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
COPYING [new file with mode: 0644]
README.md [new file with mode: 0644]

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..d5bf1a6
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 IPFire Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..34b3ebd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# IPFire Presentation Template
+
+This is a template for presentations about IPFire built with LaTeX Beamer.
+
+## Requirements
+
+| Tool | Purpose | Package (Debian/Ubuntu) |
+|------|---------|------------------------|
+| `xelatex` | PDF renderer | `texlive-xetex` |
+| `autoconf` ≥ 2.69 | Build system bootstrap | `autoconf` |
+| `automake` | Makefile generation | `automake` |
+| `bibtex` | Bibliography (optional) | `texlive-bibtex-extra` |
+
+## Quickstart
+
+### 1. Bootstrap the build system
+
+Run this once after cloning (generates `configure` and `Makefile.in`):
+
+```sh
+./autogen.sh
+```
+
+### 2. Configure
+
+```sh
+./configure
+```
+
+### 3. Build
+
+```sh
+make
+```
+
+The PDF is written to `build/presentation.pdf`.
+
+## Make Targets
+
+| Target | Description |
+|--------|-------------|
+| `make` | Build the presentation PDF |
+| `make clean` | Remove LaTeX auxiliary files |
+| `make distclean` | Remove auxiliary files **and** the PDF |
+| `make dist` | Create a tarball of the LaTeX sources |
+
+## Adding Slides
+
+1. Create a new file under `src/slides/`, e.g. `src/slides/04-demo.tex`.
+2. Add `\input{slides/04-demo}` to `src/presentation.tex`.
+3. Run `make`.
+
+## Section Divider Slides
+
+Use the `\sectionframe` command for full-screen section breaks:
+
+```latex
+% Title only
+\sectionframe{My Section Title}
+
+% Title + subtitle
+\sectionframe[Optional subtitle]{My Section Title}
+```
+
+## Licence
+
+This template is released under the [MIT Licence](COPYING).