aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..56c22be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Thesis
+
+A repository for everything related to my thesis.
+
+## Install instructions
+
+The required `.sty` and `.cls` files are stored in the [summary](./summary)
+directory. If they need to be regenerated, run `make` in the copied
+[template](./template) directory and [replace package srcpage2] with
+`scrlayer-scrpage`. The font install instructions seem a bit broken. Here's
+how to get the [garamondx font installed][] on a Debian system:
+
+ $ wget https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts
+ $ texlua install-getnonfreefonts
+ $ getnonfreefonts --user garamondx
+
+[replace package srcpage2]: https://tex.stackexchange.com/questions/541766/latex-error-file-scrpage2-sty-not-found
+[garamondx font installed]: https://tug.org/fonts/getnonfreefonts/
+
+## Build instructions
+
+### Collection thesis
+
+In the [summary](./summary) directory:
+
+ $ latexmk -pdf
+
+## Notes to self
+
+ - Create a unified preamble with defines and packages
+ - Labels for sections, figures, etc., need to be globally unique
+ - Cites and bib files are not coupled across different chapters