From 6731e43c667bcd67d04619a43835be128fbc1c46 Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Sat, 30 Apr 2022 14:09:01 +0200
Subject: [PATCH] doc: more detail on logo selection

---
 README.md | 34 ++++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 875004f..45c3d17 100644
--- a/README.md
+++ b/README.md
@@ -12,10 +12,10 @@ As these packages are meant to be used within the institution only, there is no
 need to publish them officially on CTAN. The only way to get them is through
 this repository (see Installation).
 
-
 ## Package list
 
 ### ULiege-colors
+
 This package implements the official color palette of the University of Liège.
 The full palette is available in RGB, HTML or CYMK conventions.
 
@@ -23,8 +23,8 @@ The full palette is available in RGB, HTML or CYMK conventions.
 must always be present in your system/project directory before trying to using
 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
@@ -39,8 +39,8 @@ software license CC-BY-SA 4.0.  Trigon has been integrated in TexLive in April
 Latex (if not, just update your system and install the package through your
 package manager).
 
-
 ### 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
@@ -55,34 +55,39 @@ 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._
 
-
 ### To be determined
+
 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)
 - Posters (no idea yet)
 - Letters (based on scrlttr2)
 
-
 ## Installation
+
 The proper installation procedure is still to do.
 
 For now, just copy the content of this repository (the `*.sty`files and than
 `images/` folder) in the root of your latex project and just use the package as
 any other one
+
 ```latex
 \usepackage{uliege-colors}
 \usepackage{uliege-trigon}
 ```
 
 ## Documentation
+
 The complete documentation for these packages is not written yet. This section
 is a very short summary.
 
 ### ULiege-colors
+
 Simply load the package. You can then use the custom colors as you would for any
 regular color
+
 ```latex
 \usepackage{uliege-colors}
 \begin{document}
@@ -95,14 +100,16 @@ of the applied sciences faculty.
 For all the color names (and their attribution), refer to the content of
 `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}
 ```
 
 Where
+
 - `XXX` is used to customize the color theme and can
   be one of the following:
   - uliege: ULiege style (default)
@@ -119,21 +126,24 @@ Where
   - hec: HEC (Management School)
   - arch: Architecture
 
-- `YYY` is the logo to use on the titleslide
+- `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)
 
-- `ZZZ` is the logo to use for the regular slides
-  - none: no logo on normal slides
+- `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)
 
-If nothing is mentioned, the default values are applied.
-
-
+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
+following the faculty theme). In that case, the `uliege` logo will be used
+by default, even though you specified `slidelogo=fac`.
 
 ## License
+
 Copyright 2021 by Thomas Lambert <t.lambert@uliege.be>.
 
 **Author and maintainer**: Thomas Lambert.
-- 
GitLab