diff --git a/uoe-letter/README.md b/uoe-letter/README.md new file mode 100644 index 0000000..bfb0d1e --- /dev/null +++ b/uoe-letter/README.md @@ -0,0 +1,43 @@ +# uoe-letter + +A LaTeX class (based on the letter class of the +[KOMA-Script bundle](https://www.ctan.org/pkg/koma-script) that +approximates the +[letter layout](https://www.exeter.ac.uk/media/universityofexeter/communicationservices/documents/Corporate_Letterhead.docx) +of the University of Exeter. + +## Disclaimer + +Please not that this LaTeX setup is neither endorsed nor officially +supported by the University of Exeter. + +## Prerequisites + +* The `uoe-logo` style. + +## Installation + +* Copy the `uoe-letter.cls` and `uoe.lco` into your `texmf` tree. +* Edit your personal contact and departmental information in the + `personal.lco` file. +* Run LaTeX on the `example.tex` to create a personalised example + letter. + +## Usage + +The `uoe-letter` class is a customised setup of the letter class of the +[KOMA-Script bundle](https://www.ctan.org/pkg/koma-script). Thus, please +see the KOMA-Script bundle documentation for its detailed use. + +## License + +This project is dual-licensed under a 2-clause BSD-style license and/or +the LPPL version 1.3c or (at your opinion) any later version. + +SPDX-License-Identifier: LPPL-1.3c+ OR BSD-2-Clause + +## Master Repository + +The master git repository for this project is hosted by the [Software +Assurance & Security Research Team](https://logicalhacking.com): +.