From: Michael Orlitzky <michael@orlitzky.com>
Date: Fri, 8 Apr 2016 01:25:37 +0000 (-0400)
Subject: Add a README (sort of) explaining how to use this thing.
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=3baf04cc6a1e105fe0b47ed40448f5b1a54337dd;p=beamer-mjo.git

Add a README (sort of) explaining how to use this thing.
---

diff --git a/README b/README
new file mode 100644
index 0000000..495d2c4
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+== What ==
+
+The "UMBC" Beamer theme I use in all of my presentations at UMBC.
+
+== How ==
+
+In the makefile of your project, you should list all of the pieces of
+the theme. For example,
+
+  UMBC  = beamercolorthemeUMBC.sty beamerfontthemeUMBC.sty
+  UMBC += beamerinnerthemeUMBC.sty beamerouterthemeUMBC.sty
+  UMBC += beamerthemeUMBC.sty images/umbc_logo.pdf
+
+The absolute paths to those libraries, on your system, can be found
+using "kpsewhich" from the kpathsea suite:
+
+  UMBCPATHS = $(shell kpsewhich $(UMBC))
+
+Now add those as dependencies of your document:
+
+  example.pdf: example.tex example.bbl ... $(UMBCPATHS)
+
+WARNING: This will only work as long as the path to beamer-umbc is in
+your $TEXINPUTS environment variable! I suggest setting it in
+~/.bashrc.