Improve README

jroimartin · Jan 28, 2015 · 94b3f0b · 94b3f0b
1 parent 992de08
commit 94b3f0b
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 21 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# ssg - simple slide generator
+
+## Description
+
+ssg is a slide generation system which provides a markdown-like syntax.
+
+## Usage
+
+`cat slides | ssg > slides.ps`
+
+See t/test for typical use cases.
+
+## Customization
+
+Copy doc/config to your working directory and customize it. Then, load the
+new config with:
+
+`cat slides | ssg -c config > slides.ps`
+
+## Encoding
+
+`ssg < slides | iconv -f UTF-8 -t L1 > slides.ps`
+
+## Author
+
+* Nibble \<develsec.org\>