From 72d1e38f02b6f4f426a3c5ba631bfe658d1780ac Mon Sep 17 00:00:00 2001 From: Jonas Dujava Date: Mon, 7 Oct 2024 22:52:22 +0200 Subject: [PATCH] docs(readme): add quick bullet points about template Signed-off-by: Jonas Dujava --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7437d5b..4793e07 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,19 @@ and by proxy about you and your competence level? If yes, then a classy, typographically professional layout and structured, clear, and revealing content can only help. This template tries to aid you in both of these endeavors. +Here’s what the **TeXtured** Template offers: +- ✨ **A typographically elegant layout** with various features to make your document stand out. +- πŸ› οΈ **A clean code structure** with plenty of comments to help you easily customize the template to your needs. +- πŸ”— **Seamless GitHub integration** (via GitHub Actions) to streamline version control and collaboration. +- πŸ“„ **PDF/A compliance** and *front matter* supporting theses at [MFF](https://www.mff.cuni.cz/en) πŸŽ“. + To learn more about the design principles behind `TeXtured` and its capabilities, look at the [TeXtured Demo](https://jdujava.github.io/TeXtured/thesis.pdf). It showcases the -features of `TeXtured` template and provides a guide on how to use them (still WIP 🚧). +features of `TeXtured` template and provides a guide on how to use them. + +> [!NOTE] +> Please note that the documentation is still a work-in-progress 🚧, +> with more guides and explanations to come. > [!TIP] > If you find something interesting or useful, but adopting the whole template @@ -49,16 +59,12 @@ LaTeX build tools: > + `sed` - substituting placeholders in PDF watermark > + `ghostscript` - injecting `postscript` watermark into PDF - - - Version control: - `git` - (obviously) the preferred version control system - `git-lfs` - [Git Large File Storage](https://git-lfs.github.com/) - for storing PDFs, figures, etc. - -## πŸ“„ License +## πŸ“œ License Exceptions: - 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).