Skip to content

Commit

Permalink
docs(readme): add quick bullet points about template
Browse files Browse the repository at this point in the history
Signed-off-by: Jonas Dujava <jonas.dujava@gmail.com>
  • Loading branch information
jdujava committed Oct 7, 2024
1 parent b21e9a6 commit 72d1e38
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -49,16 +59,12 @@ LaTeX build tools:
> + `sed` - substituting placeholders in PDF watermark
> + `ghostscript` - injecting `postscript` watermark into PDF
<!-- TODO: maybe describe what to disable if running on Windows -->
<!-- TODO: maybe utilize [details](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) -->

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.

<!-- TODO: maybe describe what to disable if someone doesn't want to use `git-lfs` -->

## 📄 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).
Expand Down

0 comments on commit 72d1e38

Please sign in to comment.