[thesis] Add README and CHANGELOG

York-Thesis/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+Changes (2022/07/08) - v1.0:
+- Provision of the class with a structured example

York-Thesis/README.md

@@ -0,0 +1,24 @@
+# The `yorkthesis` class
+
+This folder contains everything to get started with creating a good thesis using the `yorkthesis` class using a structure into subfiles.
+This class has been implemented initially by A. Pezzoni during his PhD at the University of York and was uploaded on his [github repository](https://github.com/donbex/yorkthesis).
+It is now provided as a full thesis template to the maths department by A. Grau who is responsible for maintaining it.
+
+If you want to see how the end result after compilation of this project looks like, you can scroll through the `main.pdf` file.
+
+In order to provide a complete example and template, this project is composed of the following files: `yorkthesis.cls`, `thesisoptions.sty`, `main.tex`, `main.pdf` and `mypreamble.tex` located in the root directory, as well as the files `intro.tex`, `intro.pdf`, `beg.tex`, `beg.pdf`, `mid.tex` and `end.tex` split into different folders.
+
+## Important notice
+This project is in some sense still a work in progress, and some of the features use fairly recent packages.
+This means that some technical difficulties can occur (compilation not behaving well, cross-references not appearing when working on subfiles...) but an up-to-date installation (as of July 2022) usually makes it work appropriately and the compilation of the `main.tex` file should give the expected result.
+
+There might also be some documentation missing and I am planning on adding a few additional things as time goes along.
+However, if there is a feature you would like me to implement or you have found something not working as you would like, do fill in an issue or send me a message and I will look into it.
+
+## Using the code
+To use this class, you can download the code directly into your computer, and start playing around with the different TeX files.
+Another possibility is to make a copy of its corresponding [Overleaf project](https://www.overleaf.com/read/mmprbwrdbgbx) for use on the platform.
+
+The code has been documented throughout, but the content of the `intro.pdf` file (which corresponds to the first chapter of the `main.pdf` file) contains a more general introduction and documentation, which can be easier to grasp in the first place rather than reading all the comments lying around.
+
+Good luck with your writing!