Added license information and made README more useful.

[tokkeebeamer.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..769af37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+tokkee's utilities / add-ons for LaTeX beamer
+=============================================
+
+This project provides a set of LaTeX packages I use to generate presentation
+slides. It may or may not be useful to anyone else …
+
+The files are provided under the terms of the 2-clause BSD license. See
+LICENSE for details.
+
+Required packages
+-----------------
+
+On a Debian system, you'll need the following packages:
+
+  * lmodern
+  * texlive-latex-recommended (beamer)
+  * texlive-pictures (pgf / tikz)
+
+For the example slides, you'll also need these packages:
+
+  * fonts-wqy-zenhei (Chinese font)
+  * texlive-xetex
+
+Author
+------
+
+Sebastian “tokkee” Harl <sh@tokkee.org>