From d02e1b836ed59900615a7bcd6b1d1349558998ec Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Wed, 11 May 2022 09:47:31 +0200
Subject: [PATCH] doc: update defaults and improve style

---
 README.md | 93 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 49 insertions(+), 44 deletions(-)

diff --git a/README.md b/README.md
index 69fae1f..d3ce914 100644
--- a/README.md
+++ b/README.md
@@ -20,37 +20,36 @@ This package implements the official color palette of the University of Liège.
 The full palette is available in RGB, HTML or CYMK conventions.
 
 **Important**: This package is a dependency for all other packages, therefore it
-must always be present in your system/project directory before trying to using
-the other packages.
+must always be present in your system (or at least in the project directory)
+before trying to use the other packages.
 
 ### ULiege-trigon
 
-This package customizes the [Trigon theme for
-Beamer](https://www.gitlab.com/thlamb/beamertheme-trigon) in order to follow the
-ULiège style recommendations. Its main purpose is to pick the right color
-palette and logos for the different faculties of the University.
+This package customizes the [Trigon theme for Beamer][trigon-repo] in order to
+follow the ULiège style recommendations. Its main purpose is to pick the right
+color palette and logos for the different faculties of the University.
 
-The Trigon theme is available directly on
-[CTAN](https://ctan.org/pkg/beamertheme-trigon). The source code of this theme
-is on my [personal gitlab
-repository](https://www.gitlab.com/thlamb/beamertheme-trigon), under the free
-software license CC-BY-SA 4.0.  Trigon has been integrated in TexLive in April
-2021, therefore it should be readily available on all new installations of
-Latex (if not, just update your system and install the package through your
-package manager).
+The Trigon theme is available directly on [CTAN][trigon-ctan]. The source code
+of this theme is on my [personal gitlab repository][trigon-repo], under the free
+software license CC-BY-SA 4.0. Trigon has been integrated in TexLive in April
+2021, therefore it should be readily available on all new installations of Latex
+(if not, just update your system and install the package through your package
+manager).
+
+I also published an official template for the Trigon theme on the [Overleaf
+template gallery][trigon-overleaf] to bootstrap quickly a presentation.
 
 ### ULiege-KOMAthesis
 
 This package customizes the `scrbook` document class (provided by the
-[KOMA-script](https://www.ctan.org/tex-archive/macros/latex/contrib/koma-script)
-package) in order to make nice looking, modern thesis. This package is largly
-inspired by the excellent [cleanthesis package](http://cleanthesis.der-ric.de/)
-by Ricardo Langner.
+[KOMA-script][koma-ctan] package) in order to make nice looking, modern thesis.
+This package is largely inspired by the excellent [cleanthesis
+package][cleanthesis-web] by Ricardo Langner.
 
 _As the graphical guidelines of the University do not explicitly mention theses,
 some compromises regarding the exact graphical guidelines were made (fonts,
 headers, margins,...). Moreover, I do not really feel that these guidelines are
-really approriate for long scientific documents anyway (such as theses). If I
+really appropriate for long scientific documents anyway (such as theses). If I
 have some spare time at some point, I may check with the communication
 department how to improve the style to match closely the official guidelines.
 But this is not a priority as of today._
@@ -61,7 +60,8 @@ I also plan to create the following packages if I find some free time (or when I
 will need them):
 
 - Short reports (based on scrreprt)
-- Long reports (based on scrreprt, very similar to ULiege-KOMAthesis)
+- Long reports (based on scrreprt, result would probably be similar to
+  ULiege-KOMAthesis)
 - Posters (no idea yet)
 - Letters (based on scrlttr2)
 
@@ -74,8 +74,8 @@ For now, just copy the content of this repository (the `*.sty`files and than
 any other one
 
 ```latex
-\usepackage{uliege-colors}
-\usepackage{uliege-trigon}
+\usepackage{ULiege-colors}
+\usepackage{ULiege-trigon}
 ```
 
 ## Documentation
@@ -89,7 +89,7 @@ Simply load the package. You can then use the custom colors as you would for any
 regular color
 
 ```latex
-\usepackage{uliege-colors}
+\usepackage{ULiege-colors}
 \begin{document}
 \color{ulgBlueGreen}{This text is in Blue-Green}, the official color of the
 Univeristy; while \color{ulgOrange}{This text is in Orange}, the official color
@@ -98,44 +98,44 @@ of the applied sciences faculty.
 ```
 
 For all the color names (and their attribution), refer to the content of
-`Uliege-colors.sty`.
+`ULiege-colors.sty`.
 
 ### ULiege-trigon
 
 In a beamer document using the Trigon class, load the package as follows
 
 ```latex
-\usepackage[faculty=XXX,titlelogo=YYY,slidelogo=ZZZ]{uliege-trigon}
+\usepackage[faculty=XXX,titlelogo=YYY,slidelogo=ZZZ]{ULiege-trigon}
 ```
 
 Where
 
 - `XXX` is used to customize the color theme and can
   be one of the following:
-  - uliege: ULiege style (default)
-  - ssoc: Social sciences
-  - apps: Applied sciences
-  - med: Medicine
-  - agro: Agro-Bio Tech
-  - gemb: Gembloux agro-bio tech
-  - psy: Psychology
-  - phi: Philosophy
-  - sci: Sciences
-  - vet: Veterinary medicine
-  - law: Law
-  - hec: HEC (Management School)
-  - arch: Architecture
+  - `uliege`: ULiege style (default)
+  - `ssoc`: Social sciences
+  - `apps`: Applied sciences
+  - `med`: Medicine
+  - `agro`: Agro-Bio Tech
+  - `gemb`: Gembloux agro-bio tech
+  - `psy`: Psychology
+  - `phi`: Philosophy
+  - `sci`: Sciences
+  - `vet`: Veterinary medicine
+  - `law`: Law
+  - `hec`: HEC (Management School)
+  - `arch`: Architecture
 
 - `YYY` is the logo to use on the titleslide. Three values are possible:
-  - none: no logo on titleslide
-  - uliege: ULiege logo
-  - fac: (default) Faculty logo (as defined with faculty=XXX)
+  - `none`: (default) no logo on titleslide
+  - `uliege`: ULiege logo
+  - `fac`: Faculty logo (as defined with faculty=XXX)
 
 - `ZZZ` is the logo to use for the regular slides. The three same options are
   possible for the `slidelogo`:
-  - none: no logo on content slides
-  - uliege: ULiege logo
-  - fac: (default) Faculty logo (as defined with faculty=XXX)
+  - `none`: no logo on content slides
+  - `uliege`: (default) ULiege logo
+  - `fac`: Faculty logo (as defined with faculty=XXX)
 
 If nothing is mentioned, the default values are applied. Note that some
 faculties do not have a custom `slidelogo` (the "U" with the triangles colored
@@ -155,3 +155,8 @@ If you encounter some issues or have ideas/feature requests, do not hesitate to
 contact me or use the issue tracker.
 
 [lppl]: https://www.latex-project.org/lppl/
+[trigon-repo]: https://gitlab.com/thlamb/beamertheme-trigon
+[trigon-ctan]: https://ctan.org/pkg/beamertheme-trigon
+[trigon-overleaf]: https://www.overleaf.com/latex/templates/trigon-beamer-theme/wjyyzvdzqkgf
+[koma-ctan]:https://www.ctan.org/tex-archive/macros/latex/contrib/koma-script
+[cleanthesis-web]:http://cleanthesis.der-ric.de/
-- 
GitLab