Skip to content

Commit 0b48a22

Browse files
authored
Update README.md
1 parent 41d65ea commit 0b48a22

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# LaTeX-Cookbook
2-
A repository for creating a cookbook from recipes
1+
# 📚 LaTeX-Cookbook
2+
3+
This repository contains a custom LaTeX-based system for compiling a beautifully formatted cookbook from modular recipe files.
4+
5+
Each recipe is written in its own `.tex` file and assembled into a complete PDF cookbook using GitHub Actions.
6+
7+
---
8+
9+
## 📖 How It Works
10+
11+
- Recipes are written as individual `.tex` files in the `recipes/` folder using a custom `recipebook` document class.
12+
- The `main.tex` file assembles everything using `\input`.
13+
- PDF builds are automated with GitHub Actions (`build-pdf.yml`).
14+
- Artifacts like processed images and class files are managed and uploaded via workflows.
15+
- The final PDF is automatically released using `release.yml`.
16+
17+
18+
## ✅ Features
19+
20+
- Modular recipe files
21+
- Automatic PDF generation via GitHub Actions
22+
- Versioned GitHub Releases with PDF download
23+
- Custom `recipebook` LaTeX class
24+
25+
---
26+
27+
## 📌 TODOs & Improvements
28+
29+
- [ ] **Improve Table of Contents (`toc.tex`)**
30+
- [ ] **Redesign `titlepage.tex`**
31+
- [ ] **Auto-include recipes**
32+
- [ ] **Localization**
33+
34+
## License
35+
36+
Distributed under the MIT License. See `LICENSE.txt` for more information.

0 commit comments

Comments
 (0)