Skip to content

Commit 642446e

Browse files
authored
Update README.md
1 parent 8a78d00 commit 642446e

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# 📚 LaTeX-Cookbook
22

3-
This repository contains a custom LaTeX-based system for compiling a beautifully formatted cookbook from modular recipe files.
3+
A custom LaTeX system for building a beautifully formatted, modular cookbook from standalone recipe files.
44

55
Each recipe is written in its own `.tex` file and assembled into a complete PDF cookbook using GitHub Actions.
66

77
### 📖 Recipe Preview
88

9-
Here’s an example preview of how a recipe looks when compiled:
9+
Preview of a compiled recipe page:
1010

1111
<img src="./assets/page.webp" alt="Recipe Preview" width="300"/>
1212

@@ -30,6 +30,19 @@ This cookbook must be compiled using XeLaTeX, not pdflatex, in order to:
3030
- Use system fonts
3131
- Ensure proper layout as defined by the recipebook class
3232

33+
## 🌐 Language Settings
34+
35+
You can set the main language of your cookbook in the `recipebook.cfg` file:
36+
37+
```latex
38+
% recipebook.cfg
39+
% Set the main language of the cookbook.
40+
% Change this to 'german', 'french', 'spanish', etc. to localize labels and babel.
41+
\newcommand{\recipebooklang}{german}
42+
```
43+
> [!NOTE]
44+
> Currently, English, German, French and Spanish are supported. More languages may be added in future updates.
45+
3346
---
3447

3548
## 📖 How It Works
@@ -69,12 +82,19 @@ Each recipe lives in its own `.tex` file inside the `recipes/` directory.
6982
\end{steps}
7083
\end{recipe}
7184
```
72-
> 📸 **Image Tip:**
73-
> Place the image file `SpaghettiBolognese.jpg` (or `.png`, etc.) inside the `/images/` directory.
85+
86+
### 📷 Required Image
87+
88+
Each recipe **must** include an accompanying image file (e.g., `.jpg`, `.png`) placed in the `/images/` directory.
89+
90+
For example, for `recipes/SpaghettiBolognese.tex`, you should place the image at `images/SpaghettiBolognese.jpg`
91+
92+
> [!WARNING]
93+
> **The image filename must match the path provided in** `\setRecipeMeta{...}{...}{...}{...}{./images/SpaghettiBolognese}`
7494
7595
### 🧩 Include the Recipe in the Book
7696

77-
Open `main.tex` and add your recipe using `\input`:
97+
Add your new recipe to `main.tex` using `\input`:
7898

7999
```latex
80100
\documentclass{recipebook}

0 commit comments

Comments
 (0)