added Usage information to readme

arthurk · Jan 7, 2009 · 3a701e3 · 3a701e3
1 parent 880eee8
commit 3a701e3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 build/
+MANIFEST
+dist/
diff --git a/README.markdown b/README.markdown
@@ -10,6 +10,18 @@ Requirements
 - [PyYAML][pyyaml] 3.07
 - [Pygments][pygments] 1.0 (Optional, used for syntax highlighting)
 
+Usage
+-----
+
+Pass yml2tex a YAML file as the first argument. The output will
+be printed to stdout.
+
+    yml2tex foobar.yml > foobar.tex
+
+The document can then be compiled:
+
+    pdflatex foobar.tex
+
 Structure
 ---------