summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md')
-rw-r--r--macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md50
1 files changed, 33 insertions, 17 deletions
diff --git a/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md b/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md
index 2643816c1f..ebb5cdd058 100644
--- a/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md
+++ b/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/README.md
@@ -19,8 +19,8 @@ high degree of customization.
The main design focuses on triangular shapes for major layout elements and noise
minimization for the main body of the work.
-The theme is now available on [CTAN](https://ctan.org/pkg/beamertheme-trigon)
-and a template is publicly available on the [Overleaf
+The theme is available on [CTAN](https://ctan.org/pkg/beamertheme-trigon)
+and a demo template is publicly available on the [Overleaf
Gallery][overleaf-gallery].
Feature requests, issues and pull requests are welcome.
@@ -69,7 +69,7 @@ install it manually by following these steps:
archive](https://gitlab.com/thlamb/beamertheme-trigon/-/archive/master/beamertheme-trigon-master.zip)
2. **Compile the style files** by running `make sty` inside the downloaded
directory. (Or run LaTeX directly on `source/trigontheme.ins`.)
-3. **Move the resulting `*.sty` files** to the folder containing your
+3. **Move the resulting `.sty` files** to the folder containing your
presentation. To use Trigon with many presentations, run `make install` or
move the `*.sty` files to a folder in your TeX path instead.
4. **Use the theme** by declaring `\usetheme{trigon}` in the preamble of your
@@ -77,16 +77,29 @@ install it manually by following these steps:
### Overleaf
-Since October 2021, [TexLive 2021 is available on
-Overleaf](https://www.overleaf.com/blog/tex-live-2021-now-available). Trigon is
-therefore automatically supported for new documents. If you want to switch older
-documents to use the Trigon theme, you need to [select TexLive 2021 or higher as
-your TeX Live
-version](https://www.overleaf.com/blog/new-feature-select-your-tex-live-compiler-version)
-(this may cause issues with other packages used in your presentation).
+The version of **Trigon** available on Overleaf may not be the latest one.
+Overleaf relies on Texlive for its backend latex installation, which they update
+once a year (typically around end of Q3). Depending on the time of the year, it
+is therefore possible that some of the latest features and developments are not
+available on Overleaf.
-In addition to that, a template project was created and is publicly available in
-the [Overleaf Gallery][overleaf-gallery] to bootstrap your presentation.
+_Note that you can see the current version of all packages by using `\listfiles`
+in the preamble of the document and looking at the logs of the compilation._
+
+Moreover, to avoid breaking changes, documents created with one version of
+TexLive keep this same version when they are edited. To use a more recent
+version of Trigon in your older documents, you need to [instruct Overleaf to use
+the most recent
+TexLive](https://www.overleaf.com/blog/new-feature-select-your-tex-live-compiler-version)
+Keep in mind that this may cause issues with other packages used in your
+presentation that would be updated as well.
+
+If you still want to use the very latest development, it is best to download the
+source code of the package here or over CTAN, compile the `.sty` files locally
+and place them at the root of you project on CTAN.
+
+A template project was created and is publicly available in the [Overleaf
+Gallery][overleaf-gallery] to bootstrap your presentation.
## Usage
@@ -105,19 +118,18 @@ following criteria:
- Maximum three main triangles on the layout
- Blending type "multiply" for overlapping triangles
- Triangles must all be equilateral (60° angles), some useful macros are
- defined in _beamerinnerthemettrigon.dtx_ for that
+ defined in _beamerinnerthemettrigon.dtx_ for that
## References & Acknowledgment
- The theme structure and options are heavily based on the [Metropolis
theme](https://github.com/matze/mtheme)
-- Illustration picture for the demo titlepage from Taryn Elliott @
- [pexels](https://pexels.com) (published under Pexel License, free to use
- without attribution).
+- The picture used on the title page of the demo is "_Man in Red Jacket Standing
+ on the Stairs_": Photo by [Taryn Elliott from Pexels][man-red-jacket].
## License
-Copyright 2021 by Thomas Lambert <trigon@thl.ovh>.
+Copyright 2021-2023 by Thomas Lambert <trigon@thl.ovh>.
**Author and maintainer**: Thomas Lambert.
@@ -126,8 +138,12 @@ International License](https://creativecommons.org/licenses/by-sa/4.0/), which
is essentially a _free software_ license. Do not hesitate to copy and modify
the code to fit your needs.
+Some parts of this repository may be released under a different license than the
+main theme. See the [NOTICE.md](NOTICE.md) file for more details.
+
[demo-shield]: https://img.shields.io/badge/Demo-PDF-blue.svg
[docs-shield]: https://img.shields.io/badge/Documentation-PDF-blue.svg
[demo-url]: https://gitlab.com/thlamb/beamertheme-trigon/-/jobs/artifacts/master/raw/demo/trigon_demo.pdf?job=tex-compile
[docs-url]: https://gitlab.com/thlamb/beamertheme-trigon/-/jobs/artifacts/master/raw/docs/trigontheme.pdf?job=tex-compile
[overleaf-gallery]: https://www.overleaf.com/latex/templates/trigon-beamer-theme/wjyyzvdzqkgf
+[man-red-jacket]: https://www.pexels.com/photo/man-in-red-jacket-standing-on-the-stairs-4390730/