add readme

2015-08-20 13:33:59 +02:00 · 2015-08-20 13:33:59 +02:00 · 46777623b4
commit 46777623b4
parent 429fc43b74
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,17 @@
+# Calendar 2015
+A calendar for the year 2015, built in LaTeX. The main work is done by the `calpage` command which is based on the [birthday calendar example](www.texample.net/tikz/examples/birthday-calendar/) by Hakon Malmedal.  
+Of course the command is usaable for years to come, not only 2015 ;)  
+
+The images are licensed as [cc-by 4.0](ihttp://creativecommons.org/licenses/by/4.0/) as is the command.
+
+# Prerequisites
+- [LuaTeX](http://www.luatex.org/)
+- some kind of shell if you want to use the build script (which does nothing fancy, it is mainly a memory hook)
+
+# Usage
+```
+./build
+```
+
+You'll find the generated pdf in a folder called *out*
+