diff --git a/README.md b/README.md index 244b9c17c34df8f731c732a2bb2b8b2f965a64b7..8333b7d507478f45894e5e9a9077027bf87f81a8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,38 @@ # University Of Southampton LaTeX documents LaTeX Documents for the University of Southampton. Mainly for Thesis and project reports -This whole folder can be moved into the ~/texmf directory to begin using the class files. +## Your `{TEXMF}` root subdirectory +For Tex Live: This whole folder can be moved into the `~/texmf` directory to begin using the class files. +For MikTeX: It is platform dependent, See `UserInstall` from (https://miktex.org/kb/texmf-roots) + +## The folder post install +If using the zip download there may be one or two containing directories before the actual +folders that need copying. Once the folder has been extracted your `{TEXMF}` directory should +look like so. + +``` ++-{TEXMF} + +-bibtex + | +-bib + | | +-uosdocs + | +-bst + | +-uosdocs + +-doc + | +-latex + | +-uosdocs + +-templates + | +-latex + | +-uosdocs + +-tex + | +-latex + | +-uosdocs + +-source + +-docstrip + +-uosdocs +``` + +## About this package Created with docstrip `.ins` and `.dtx` files in the source directory. See the Instructions manual for more info about usage and building. The version hosted on https://git.soton.ac.uk/el7g15/uos-latex-template is kept up to date with the University of Southampton template. The version hosted on GitHub may diverge from that.