From e5870f5ad1d722c6213ff75dac9f034f498f148e Mon Sep 17 00:00:00 2001 From: MiguelMJ Date: Tue, 10 Mar 2026 20:08:09 +0100 Subject: [PATCH] docs: explain formats --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index e69de29..0c6a2a9 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,40 @@ +# Bokeron template + +Este repositorio contiene las plantillas en distintos formatos para elaborar diapositivas destinadas a talleres y eventos de Open Bokeron. + +## Formatos disponibles + +### LaTeX + +**Cómo usar** + +1. Copiar a la raiz de tu proyecto: + - `main.tex` + - `beamerthemeBokeronTemp.sty` + - `images/` + - `background/` +2. Opcionalmente, copiar `sections/` y crear ahí las secciones de tus diapositivas. +3. Editar los `\input` en `main.tex` para que incluyan tus propias secciones. Alternativamente, eliminar los `\input` y editar directamente el contenido del `main.tex`. + +### Typst + +**Cómo usar** + +1. Copiar a la raiz de tu proyecto: + - `openbokeron.typ` +2. Crear un fichero principal (por ejemplo `main.typ`) y añadir la siguiente cabecera: + + ```typst + #import "openbokeron.typ": OpenBokeron + #show: OpenBokeron.with( + title: "Mi título", + subtitle: "Mi subtítulo (opcional)", + authors: ( + (name: "Autor1", email: "example@example.com (opcional)"), + ), + //cover-image: image("mi_portada.png") // opcional + //cover-theme: "dark" // si mi portada requiere texto claro + ) + + ``` +3. Editar con normalidad el resto del documento. \ No newline at end of file