1 files changed, 48 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6a6a51a
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+This directory contains the source files to typeset the article, 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. Most of these are drop-in replacements for those
+defined in the 'article' class.
+
+Some extra functionality is provided in custom style files, located in the
+'libs' directory.
+
+
+* Dependencies:
+
+  pdflatex
+  TeXlive packages:
+    amsfonts
+    color
+    doublestroke
+    graphics
+    hyperref
+    latex
+    marginnote
+    pgf
+    standalone
+  GNU make
+  python3
+  gnuplot
+
+* Files:
+
+  Jauslin_IAMP_2018.tex:
+    main LaTeX file
+
+  libs:
+    custom LaTeX class and style files
+
+  figs:
+    source code for the figures
+
+  figs/dimer_example.fig/dimer_conf.py:
+    this python script randomly generates a suitable dimer configuration for
+    the figures interaction.pdf boundary.pdf and dimer_contour.pdf
+
+  figs/atoms.fig/*.py:
+    these python script generate the figures gas.png, liquid.png, crystal.png,
+    nematic.png and chiral.png
+