diff --git a/README.md b/README.md index bc11e7a522df87be02eeb00cad6ed1936dc4b23f..255bb3cdbf1f84af184d58e5bb43ca06c3efb1f6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # ULiege-Latex - Customization packages for Latex classes -This repository contains various packages that can be used alongside well-known -latex classes. These packages implement specific customizations for the layout, -colors, etc that fit (or approach) the official ULiege graphical guidelines. +This repository contains various packages that can be used alongside any latex +class or package. These packages implement specific customizations for the +layout, colors, etc that fit (or approach) the official ULiege graphical +guidelines. **None of these packages are officially endorsed by the University**. They were just implemented in order to support my own material (presentation, thesis, @@ -10,14 +11,14 @@ reports, etc), produced during my Ph.D. Thesis and Teaching Assistant mandate. 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). +this repository (see [Installation][#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. +The full palette is available following RGB, HTML or CYMK conventions. **Important**: This package is a dependency for all other packages, therefore it must always be present in your system (or at least in the project directory) @@ -76,25 +77,26 @@ trigonthesis and ULiege-Trigonthesis._ 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, result would probably be similar to +- Short reports (based on `scrreprt`) +- Long reports (based on `scrreprt`, result would probably be similar to ULiege-trigonthesis) - 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 +There is no formal install script for this. Simply copy the content of this +repository (the `*.sty`files and the `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} ``` +An other possibility would be to place these directly somewhere where latex will +always find them (see the path documentation for Latex for more details). + ## Documentation The complete documentation for these packages is not written yet. This section