promec-ufrgs -- A LaTeX class for PROMEC/UFRGS theses and dissertations
========================================================================

Name:      promec-ufrgs
Version:   v0.1 (2026/07/16)
Authors:   Boris N. Rojo Tanzi, Barbara Minosso
Maintainers: Boris N. Rojo Tanzi, Barbara Minosso

Summary
-------
`promec-ufrgs.cls` extends `abntex2` to provide the formatting required by
the Graduate Program in Mechanical Engineering (PROMEC) at the
Universidade Federal do Rio Grande do Sul (UFRGS), in compliance with
Brazilian ABNT standards (NBR 14724, 6023, 10520, 6024, 6027, 6028).
It packages package loading, the cover page, the approval page, and
the pre-textual element sequence into the class itself, so that
authors only edit their own data and content files.

License
-------
This work is licensed under the LaTeX Project Public License (LPPL),
version 1.3c or later. The latest version of this license is at
https://www.latex-project.org/lppl.txt; a copy as of this release is
included as the `LICENSE` file in this package.

Requirements
------------
TeX Live 2024 (or newer) / MiKTeX with: abntex2, abntex2cite,
glossaries-extra, siunitx, pgfplots, tikz (all standard TeX Live
packages).

Installation
------------
Copy `promec-ufrgs.cls` to `TEXMFHOME/tex/latex/promec-ufrgs/` and run
`mktexlsr`/`texhash` (TeX Live) or `initexmf --update-fndb` (MiKTeX).
Alternatively, place `promec-ufrgs.cls` in the same directory as your
main `.tex` file.

Documentation
-------------
See `doc/promec-ufrgs-doc.tex` / `doc/promec-ufrgs-doc.pdf` for the full
command reference and a minimal usage example.

Example
-------
`example/exemplo.tex`, together with the stub files under `example/tex/`,
is a minimal, self-contained document that compiles on its own
(`pdflatex exemplo`, run twice, plus `makeglossaries`/`makeindex` if you
want the glossary/index lists populated). Copy it as a starting point.

Repository
----------
The full thesis template (with example chapters, bibliography, and
front-matter files) is developed at the project repository; this
package contains only the redistributable class, its documentation,
and a minimal example.