As presented at MSU on 2019-05-02v1.0

1 files changed, 48 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..49bc558
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+This directory contains the source files to typeset the presentation, and
+generate the figures. This can be accomplished by running
+  make
+
+Two animations were prepared for this talk. The first shows the time-evolution
+of the density for field emission. The source files are located in the
+'figs/animation' directory. To run the animation, run
+  cd figs/animation
+  make run
+The second shows the time-evolution of the density and current for
+photoemission. The source files are located in the 'figs/anim_laser' directory.
+To run the animation, run
+  cd figs/anim_laser
+  make run
+This can take a while the first time it is run.
+
+This document uses a custom class file, located in the 'libs' directory, which
+defines a number of commands.
+
+
+* Dependencies:
+
+  pdflatex
+  TeXlive packages:
+    amsfonts
+    array
+    graphics
+    hyperref
+    latex
+    pgf
+    standalone
+  GNU make
+  julia
+  python3
+  gnuplot
+
+
+* Files:
+
+  Jauslin_MSU_2019.tex:
+    main LaTeX file
+
+  libs:
+    custom LaTeX class file
+
+  figs:
+    source code for the figures
+