From e28d69517ee944939929d0c917df7e9060b0756d Mon Sep 17 00:00:00 2001
From: Edward Longman <eialongman@gmail.com>
Date: Tue, 8 Jun 2021 11:28:33 +0100
Subject: [PATCH] Improve README with FAQ and basic install instructions
(mostly from uos-latex-template-instructions)
---
README.md | 34 ++++++++++++++++++----------------
1 file changed, 18 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 30a3fad..fde2258 100644
--- a/README.md
+++ b/README.md
@@ -36,24 +36,28 @@ Then add ``\newcommand{\BIBdecl}{\catcode`\%=12 }`` before `\begin{document}` in
#### Q: Can I use `biblatex` instead of `natbib`?
Yes you can. Since this template has existed longer than `biblatex` it uses the older `natbib`.
there are good reasons to change to `biblatex` but `natbib` is still preferred by journals,
-so using `natbib` will mean that source material from papers will not need to be modified,
+so using `natbib` will mean that source material from papers will not need to be modified.
-## Install instructions
-### For preparing a single document - Thesis, Dissertation, Final project report
-Since you will only need this template once, go to the [Releases page](https://git.soton.ac.uk/el7g15/uos-latex-template/-/releases) and download the relevant quickstart package. Unzip and start editing the `Thesis.tex`,`Progress.tex`,`GDP.tex` file as appropriate for the report you are doing. This should compile straight away from an editor like TeXstudio.
+# Install instructions
+This is if you do not want to use a service like Overleaf or want to use a different template other than the uosthesis class provided.
+If ypu want to compile documents on your own machine, first you must install a LaTeX distribution.
+Either TeXLive or MikTeX will work. For TeXLive, you do not need a full installation (which is huge).
-### For multiple use - for progress reports, and thesis and more frequent use
-Assuming you will use the template more than once, this is definitely the preferred option.
+For detailed LaTeX Installation help please look at the [detailed template instructions](https://git.soton.ac.uk/el7g15/uos-latex-template-instructions/-/blob/master/README.pdf)
+## For preparing a single document - just one Thesis, Dissertation or Final project report
+This is if you will only need to use one template, and works on Overleaf too. Go to the [Releases page](https://git.soton.ac.uk/el7g15/uos-latex-template/-/releases) and download the relevant quickstart package. Unzip and start editing the `Thesis.tex`,`Progress.tex`,`GDP.tex` file as appropriate for the report you are doing. This should compile straight away from an editor like TeXstudio, or from the Overleaf workspace.
+## For multiple use - for Progress reports, Thesis and more frequent use
+Given you will use the template more than once, this is definitely the preferred option.
Download the `Source Code` from the [Releases page](https://git.soton.ac.uk/el7g15/uos-latex-template/-/releases) and extract it to the `{TEXMF}` folder (see below).
-#### Your `{TEXMF}` root subdirectory
+### 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).
You may need to register your directories: https://docs.miktex.org/manual/localadditions.html.
-You will need to update the filename database (FNDB) (MiKTeX Console -> Tasks ->Refresh file name database), see https://docs.miktex.org/manual/configuring.html#fndbupdate. You can do this in the command line with the `initexmf -u` command.
+You will need to update the filename database (FNDB) (MiKTeX Console -> Tasks -> Refresh file name database), see https://docs.miktex.org/manual/configuring.html#fndbupdate. You can do this in the command line with the `initexmf -u` command.
-#### The folder post install
+### 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.
@@ -62,8 +66,6 @@ look like so.
+-{TEXMF}
+-bibtex
| +-bib
- | | +-uosdocs
- | +-bst
| +-uosdocs
+-doc
| +-latex
@@ -79,17 +81,17 @@ look like so.
+-uosdocs
```
-#### Using the template
+### Using the template
Now copy the contents of the `templates/latex/uosdocs` directory into your working directory.
In the working directory, open the relevant copied root `tex` file, i.e. `Thesis.tex` etc. and begin your masterpiece.
-More info can be found in the [Instructions repository](https://git.soton.ac.uk/el7g15/uos-latex-template-instructions/-/blob/master/README.pdf)
+More info can be found in the [Instructions](https://git.soton.ac.uk/el7g15/uos-latex-template-instructions/-/blob/master/README.pdf).
-### Updating
+## Updating
Repeat the installation step and it will overwrite the existing files.
-## 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.
+# About this package
+Created with docstrip `.ins` and `.dtx` files in the source directory. See the [Instructions](https://git.soton.ac.uk/el7g15/uos-latex-template-instructions/-/blob/master/README.pdf) 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.
--
GitLab