From b3c0ac4edbb96054936ea46aafdf4a7927c5e2b4 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Wed, 14 Jan 2026 17:25:50 +0100 Subject: [PATCH] Update README.md --- README.md | 71 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 36 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 31bee42..52c5be5 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,39 @@ # podman_ravenous - -# Ravenous‑Latex Podman Builder - -A lightweight Debian‑based Podman image that bundles a minimal TeX Live installation, Rust, and the `ravenous-tools` command line suite. -It is intended to compile LaTeX documents inside a reproducible container. - -## Quick start - -```bash -# Build the image (you can replace `ravenous-latex` with any tag you prefer) -podman build -t ravenous-latex . - -# Compile a document -podman run --rm -v "$(pwd)":/workspace ravenous-latex pdflatex main.tex -``` - -The image defaults to `/workspace` as the working directory, so any mounted volume at `.` will be available for LaTeX source files. - -## Image contents - -- **Base** – `debian:stable-slim` -- **TeX Live** – minimal packages needed for most documents -- **Rust** – `cargo` installed system‑wide -- **Ravenous tools** – `cargo install` from the public repo - -## Usage - -```bash -# Help -podman run --rm ravenous-latex --help - -# Compile -podman run --rm -v "$(pwd)":/workspace ravenous-latex pdflatex main.tex -``` - + +# Ravenous‑Latex Podman Builder + +A lightweight Debian‑based Podman image that bundles a minimal TeX Live installation, Rust, and the `ravenous-tools` command line suite. +It is intended to compile LaTeX documents inside a reproducible container. + +## Quick start + +```bash +# Build the image (you can replace `ravenous-latex` with any tag you prefer) +podman build -t ravenous-latex . + +# Compile a document +podman run --rm -v "$(pwd)":/workspace ravenous-latex pdflatex main.tex +``` + +The image defaults to `/workspace` as the working directory, so any mounted volume at `.` will be available for LaTeX source files. + +## Image contents + +- **Base** – `debian:stable-slim` +- **TeX Live** – minimal packages needed for most documents +- **Rust** – `cargo` installed system‑wide +- **Ravenous tools** – `cargo install` from the public repo + +## Usage + +```bash +# Help +podman run --rm ravenous-latex --help + +# Compile +podman run --rm -v "$(pwd)":/workspace make -t glossaries -N Ravenous.tex +podman run --rm -v "$(pwd)":/workspace make -N Ravenous.tex +``` + Feel free to extend the Dockerfile or wrap it in a CI pipeline. \ No newline at end of file