README.md: Added an explanation on why we provide the ./makepdf and…

… `./makeps` scripts.

thesis.tex: Added a list of all supported doumentclass options.

README.md

@@ -17,12 +17,17 @@ desired location.
 
 Now you can start writing your thesis using the `thesis.tex` file.
 
-Finally, build the `PDF` document by running one of the following in the command line:
+Finally, build the `PDF` document by running the following in the command line:
 
     make
+
+If you're using the `glossaries` package, try using these:
+
     ./makepdf
     ./makeps
 
+The above scripts work around a bug in the supplied makefile (i.e., the makefile forgets to rebuild the glossary index when pages change between LaTeX build runs).
+
 ## How will it look like?
 
 Your thesis document will look something like this (using the Adobe Sabon font and the _clean_ sample, which can be found in [`./Samples/clean`](https://github.com/cambridge/thesis/tree/master/Samples/clean)):

thesis.tex

@@ -12,11 +12,20 @@
 %% Original License URL: http://www.freebsd.org/copyright/freebsd-license.html
 %%%%%
 
-\documentclass[index]{cam-thesis}
+% Available documentclass options:
+%
+%   <all `report` document class options, e.g.: `a5paper`>
+%   index       - enables the index. New index entries can be added through `\index{my entry}`
+%   glossary    - enables the glossary.
+%   techreport  - typesets the thesis in the technical report format.
+%   times       - uses the `Times` font.
+%
+% For more info see `README.md`
+\documentclass[index,glossary]{cam-thesis}
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Thesis meta-information
 %%
 
@@ -30,15 +39,16 @@
 %% College affiliation:
 \college{My College}
 
-%% College shield (optional):
+%% College shield [optional]:
 % \collegeshield{CollegeShields/Queens}
-\collegeshield{CollegeShields/StJohns}
+% \collegeshield{CollegeShields/StJohns}
 % \collegeshield{CollegeShields/Fitzwilliam}
+\collegeshield{CollegeShields/FitzwilliamRed}
 
-%% Submission date (optional):
+%% Submission date [optional]:
 \submissiondate{November, 2042}
 
-%% You can redefine the submission notice:
+%% You can redefine the submission notice [optional]:
 % \submissionnotice{A badass thesis submitted on time for the Degree of PhD}
 
 %% Declaration date:
@@ -50,7 +60,7 @@
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Abstract:
 %%
 \abstract{%
@@ -59,30 +69,48 @@
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Acknowledgements:
 %%
 \acknowledgements{%
   My acknowledgements ...
 }
 
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Glossary [optional]:
+%%
+\newglossaryentry{HOL}{
+    name=HOL,
+    description={Higher-order logic}
+}
+
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Contents:
+%%
 \begin{document}
 
-%% Prints the title page (is automatically omitted in the technical report
-%% mode).
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Title page, abstract, declaration etc.:
+%% -    the title page (is automatically omitted in the technical report mode).
 \frontmatter{}
 
 
 
-%%
-%% Contents:
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Thesis body:
 %%
 \chapter{Introduction}
 This document was created with the help of a custom class file~\cite{example}. A
 {\em \LaTeX{} class file}\index{\LaTeX{} class file@LaTeX class file} is a file,
 which holds style information for a particular \LaTeX{} class\footnote{You can
 find more about classes at \url{http://www.ctan.org/pkg/clsguide}.}.
 
+This is an example glossary reference: \GLS{HOL}.
+
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
@@ -121,7 +149,7 @@ \chapter{Introduction}
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Bibliography:
 %%
 
@@ -131,7 +159,7 @@ \chapter{Introduction}
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Appendix:
 %%
 
@@ -142,7 +170,7 @@ \chapter{Extra Information}
 
 
 
-%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Index:
 %%
 \printthesisindex