1 files changed, 46 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8c6907c
--- /dev/null
+++ b/README
@@ -0,0 +1,46 @@
+This directory contains the source files to typeset the presentation, and
+generate the figures. This can be accomplished by running
+  make
+
+This document uses a custom class file, located in the 'libs' directory, which
+defines a number of commands.
+
+
+* Dependencies:
+
+  pdflatex
+  TeXlive packages:
+    amsfonts
+    graphics
+    hyperref
+    latex
+    pgf
+    standalone
+    xcolor
+  GNU make
+  python3
+  gnuplot
+
+* Files:
+
+  Jauslin_EL_2018.tex:
+    main LaTeX file
+
+  libs:
+    custom LaTeX class file
+
+  figs:
+    source code for the figures
+
+  figs/dimer_conf.fig/dimer_conf.py:
+    this python script randomly generates a suitable dimer configuration for
+    the figures grid.pdf, dimers.pdf, interaction.pdf and dimer_contour.pdf.
+
+  figs/ising.fig/ising.py:
+    this python script randomly generates a suitable spin configuration for the
+    figures ising.pdf ising_blue.pdf ising_red.pdf transfer1.pdf transfer2.pdf.
+
+  figs/nematic.fig/nematic.py:
+    this python script randomly generates configurations of non-overlapping
+    ellipsoids for nematic.png.
+