Skip to content

Commit ab991d9

Browse files
[CI] Update to latest PDF and README.md
0 parents  commit ab991d9

2 files changed

Lines changed: 125 additions & 0 deletions

File tree

README.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<div align="center">
2+
<img alt="TeXtured Template" height="100px" src="https://raw.githubusercontent.com/jdujava/TeXtured/refs/heads/master/figures/TeXtured-logo-light-mode.svg#gh-light-mode-only">
3+
<img alt="TeXtured Template" height="100px" src="https://raw.githubusercontent.com/jdujava/TeXtured/refs/heads/master/figures/TeXtured-logo-dark-mode.svg#gh-dark-mode-only">
4+
</div>
5+
<div align="center">
6+
7+
[![TeXtured Manual](https://img.shields.io/badge/TeXtured-Manual%E2%80%89%F0%9F%93%93-blue?color=ccfaff&style=for-the-badge)](https://jdujava.github.io/TeXtured/thesis.pdf)
8+
 [![GitHub Release](https://img.shields.io/github/v/release/jdujava/textured?color=ade1ff&style=for-the-badge)](https://github.com/jdujava/TeXtured/releases)
9+
 [![GitHub License](https://img.shields.io/github/license/jdujava/TeXtured?color=fbe2ff&style=for-the-badge)](#-license)
10+
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jdujava/TeXtured/main.yml?color=aafaba&style=for-the-badge)](https://jdujava.github.io/TeXtured/thesis.pdf)
11+
 [![TeXtured Stars](https://img.shields.io/github/stars/jdujava/TeXtured?color=ffeca4&style=for-the-badge)](https://github.com/jdujava/TeXtured/stargazers)
12+
13+
</div>
14+
15+
Do you care in the slightest about what your readers think about your document,
16+
and by proxy about you and your competence level? If yes, then a classy,
17+
typographically professional layout and structured, clear, and revealing content
18+
can only help. This template tries to aid you in both of these endeavors.
19+
20+
Here’s what the **TeXtured** Template offers:
21+
-**typographically elegant layout** with various features to make your document stand out
22+
- 🧙 **clean code structure** with plenty of comments to help you easily customize the template to your needs
23+
- 🔗 **seamless GitHub integration** (via GitHub Actions) to streamline version control and collaboration
24+
- 📄 **PDF/A compliance** and *front matter* supporting theses at [MFF](https://www.mff.cuni.cz/en) 🎓
25+
26+
To learn more about the design principles behind `TeXtured` and its capabilities, look at the
27+
[<img align="center" alt="TeXtured Manual" src="https://img.shields.io/badge/TeXtured-Manual%E2%80%89%F0%9F%93%93-blue?color=ccfaff">](https://jdujava.github.io/TeXtured/thesis.pdf).
28+
It showcases the features of `TeXtured` template and provides a guide on how to use them.
29+
30+
> [!NOTE]
31+
> Please note that the documentation is still a work-in-progress 🚧,
32+
> with more guides and explanations to come.
33+
34+
> [!TIP]
35+
> If you find something interesting or useful, but adopting the whole template
36+
> is simply too much, feel free to just copy and use relevant parts of the code.
37+
> Also, consider starring (⭐) the repository to help others find it!
38+
39+
<picture>
40+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=jdujava/TeXtured&type=Date&theme=dark" />
41+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=jdujava/TeXtured&type=Date" />
42+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=jdujava/TeXtured&type=Date" />
43+
</picture>
44+
45+
## 🌟 Showcase
46+
47+
The main part of the `TeXtured` template development was carried out during the preparation of:<br>
48+
  Jonáš Dujava, [Strongly Coupled Quantum Field Theory in Anti-de Sitter Spacetime `[PDF]`](https://jdujava.github.io/ONinAdS/SCQFTinAdS.pdf) — Master Thesis<br>
49+
    `arXiv`: [2507.07111 \[hep-th\]](https://arxiv.org/abs/2507.07111), `GitHub`: [jdujava/ONinAdS](https://github.com/jdujava/ONinAdS)
50+
<details>
51+
<summary>👀 Quick Preview <em>(click to see a selection of pages, above is the link to the whole <code>PDF</code>)</em></summary>
52+
<img width="2776" height="2105" alt="thesis-dual00" src="https://github.com/user-attachments/assets/5c7608e8-4ed1-4e6b-b201-335fbe7fe7e3" />
53+
<img width="2776" height="2105" alt="thesis-dual01" src="https://github.com/user-attachments/assets/376a5b62-5b14-483c-87ba-da0808c51a32" />
54+
<img width="2776" height="2105" alt="thesis-dual02" src="https://github.com/user-attachments/assets/de77881b-d21e-42d6-aba4-302239bd7164" />
55+
<img width="2776" height="2105" alt="thesis-dual03" src="https://github.com/user-attachments/assets/bf719391-f5e7-4e56-baa8-05fe330bbc86" />
56+
<img width="2776" height="2105" alt="thesis-dual04" src="https://github.com/user-attachments/assets/b9ed8eaa-23b9-4cda-87b8-4dcc2510910b" />
57+
<img width="2776" height="2105" alt="thesis-dual05" src="https://github.com/user-attachments/assets/50cd1894-b374-4206-9d81-78498f15c25b" />
58+
<img width="2776" height="2105" alt="thesis-dual06" src="https://github.com/user-attachments/assets/702ce869-1f9c-4ceb-a1ce-f7ce815bfb3f" />
59+
<img width="2776" height="2105" alt="thesis-dual07" src="https://github.com/user-attachments/assets/502eafd8-7c24-47f8-84a2-3fef5415e351" />
60+
<img width="2776" height="2105" alt="thesis-dual08" src="https://github.com/user-attachments/assets/0bd1db62-d2a4-4ff0-b126-0c176ac76123" />
61+
<img width="2776" height="2105" alt="thesis-dual09" src="https://github.com/user-attachments/assets/a10b0779-4fb0-444b-b360-99545077d92a" />
62+
<img width="2776" height="2105" alt="thesis-dual10" src="https://github.com/user-attachments/assets/338c5301-bc35-47cc-ada8-b3548c160399" />
63+
</details>
64+
65+
Early predecessor of the `TeXtured` template:<br>
66+
  Jonáš Dujava, [Counting operators in Effective Field Theories `[PDF]`](https://jdujava.github.io/CountingInEFT/CountingInEFT.pdf) — Bachelor Thesis<br>
67+
    `arXiv`: [2211.05759 \[hep-th\]](https://arxiv.org/abs/2211.05759), `GitHub`: [jdujava/CountingInEFT](https://github.com/jdujava/CountingInEFT)
68+
69+
> [!TIP]
70+
> If you want to showcase your work utilizing the `TeXtured` template, feel free to open a pull request!
71+
72+
## 🏗️ Building
73+
74+
Be sure to have all the dependencies installed — at least the `LaTeX` build tools, see below — and run
75+
```sh
76+
latexmk thesis
77+
```
78+
in the root directory of the repository to build the document.
79+
80+
> [!TIP]
81+
> If you prefer to use 🍃 `Overleaf`, you can find the `TeXtured` template
82+
> [<img align="center" alt="Overleaf TeXtured Template" src="https://img.shields.io/badge/Overleaf-TeXtured-blue?color=ccffd2&logo=overleaf">](https://www.overleaf.com/latex/templates/textured/zwtzzwgddbsh)
83+
> there as well.
84+
> Note that releases `v1.3.0` and later depend on [`keytheorems`](https://github.com/mbertucci47/keytheorems) package,
85+
> which is not yet available on 🍃 `Overleaf` (you can however upload `keytheorems.sty` manually).
86+
87+
88+
## 📦 Software Dependencies
89+
90+
LaTeX build tools:
91+
- `latexmk` - LaTeX build tool
92+
- `pdflatex`/`lualatex` - LaTeX engine (you can choose one in `.latexmkrc`)
93+
- `biber` - bibliography processing tool for `biblatex`
94+
95+
> [!WARNING]
96+
> To properly build the document, the template requires `TeX Live` 2024 or later (otherwise, some packages may not be available, or you may encounter some bugs).
97+
> Using the latest version of `TeX Live` is highly recommended, which is used in the GitHub Actions workflow to build
98+
> [<img align="center" alt="TeXtured Manual" src="https://img.shields.io/badge/TeXtured-Manual%E2%80%89%F0%9F%93%93-blue?color=ccfaff">](https://jdujava.github.io/TeXtured/thesis.pdf).
99+
100+
> [!NOTE]
101+
> Some scripts assume `linux` environment. These include:
102+
> - generation of directory structure for `aux_dir` (dependencies are `sed`, `xargs`)
103+
> - vector figure generation (together with watermark)
104+
> + need to enable `--shell-escape` in `.latexmkrc`
105+
> + `inkscape` - vector graphics (and SVG to PDF conversion)
106+
> + `perl` - disabling `/Interpolation` in PDFs generated by `inkscape`
107+
> + `sed`, `uconv` - substituting placeholders in PDF watermark
108+
> + `ghostscript` - injecting `postscript` watermark into PDF
109+
110+
Version control (optional):
111+
- `git` - the preferred version control system
112+
- `git-lfs` - [Git Large File Storage](https://git-lfs.github.com/) - for storing PDFs, figures, etc.
113+
114+
115+
## 📜 License
116+
117+
Exceptions:
118+
- The MFF CUNI logo `MFF-logo.pdf` is property of the corresponding faculty, see [MFF Visual Identity](https://www.mff.cuni.cz/en/faculty/visual-identity).
119+
- Figure `parallel-plate-capacitor.svg` (with corresponding files) is property of Jonáš Dujava.
120+
121+
[<img align="center" alt="License: CC0-1.0" src="https://licensebuttons.net/p/zero/1.0/88x31.png">](https://creativecommons.org/publicdomain/zero/1.0/)
122+
 All other files are marked with
123+
[<img align="center" alt="License: CC0-1.0" src="https://img.shields.io/github/license/jdujava/TeXtured?color=fbe2ff">](https://creativecommons.org/publicdomain/zero/1.0/).
124+
125+
Even though you are free to use the source code of `TeXtured` any way you like, an acknowledgement is welcome (for example by including a citation using `\autocite{TeXtured}`).

thesis.pdf

1.1 MB
Binary file not shown.

0 commit comments

Comments
 (0)