added installation details
authorBenjamin Mako Hill <mako@atdot.cc>
Wed, 23 Dec 2009 02:55:15 +0000 (21:55 -0500)
committerBenjamin Mako Hill <mako@atdot.cc>
Wed, 23 Dec 2009 02:55:15 +0000 (21:55 -0500)
created a new readme file with:
- installation details
- dependency information
- git repo details

README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..dea5837
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+Copyright (c) 2009 Benjamin Mako Hill <mako@atdot.cc>
+
+This repository contains LaTeX configuration files that I use to format
+my papers. They are all released under the GNU GPL version 3 or later.
+
+The latest version can be found at: http://mako.cc/scripts/
+
+As scripts and configuration files, I do not "release" these files. You
+can always check out the latest version with Git with the following
+command:
+
+  git clone http://projects.mako.cc/source/latex_mako/.git
+
+Bug reports, comments, questions, and patches can all be directed to:
+
+  Benjamin Mako Hill <mako@atdot.cc>
+
+================================
+=== Dependencies ===============
+================================
+
+If you are running Debian or Ubuntu, you will first need to install the
+following packages:
+
+  * rubber
+  * texlive-latex-recommended
+  * texlive-fonts-extra
+  * texlive-fonts-recommended
+  * texlive-bibtex-extra 
+
+You can do so with the following command:
+
+  apt-get install rubber texlive-latex-recommended \
+  texlive-fonts-extra texlive-fonts-recommended \
+  texlive-bibtex-extra 
+
+I don't know the details of setting up these LaTeX files to work with on
+systems other than Debian or Ubuntu but imagine it will involve
+installing a full TeX Live distribution.
+
+In my templates, I make extensive use of the following Garamond font:
+
+  http://www.ctan.org/tex-archive/fonts/urw/garamond/
+

Community Data Science Collective || Want to submit a patch?