Permalink
Browse files

adding some documentation

  • Loading branch information...
1 parent aed2626 commit 616f3a59178f94f33c77899baa23ad34740a0e7b @FredAtLandMetrics committed Apr 18, 2012
Showing with 27 additions and 2 deletions.
  1. +2 −0 CHANGELOG
  2. +24 −1 README
  3. +1 −1 lib/olsen/version.rb
View
2 CHANGELOG
@@ -1,2 +1,4 @@
[0.0.4] initial public release...working in a lot of ways, but no docs
+[0.0.6] added olsen executable to init and process jobs, added pdf generation, unit tests
+[0.0.7] added README
View
25 README
@@ -12,6 +12,29 @@ Olsen is a framework that wraps the Sadie gem and provides a facility for produc
5. find output product in output folder
6. Rejoice!
+===Formats
+====Job files
+These should be suffixed with a '.job' and they should be in the jobs folder.
+
+=====Example
+
+ [output]
+o1=<filename in the outputs folder>
+o2=<another one>
+...
+oN=<and another>
+
+====PDF INI files
+These should go in outputs and end in '.pdf.ini'
+
+=====Example
+
+ [pdf]
+type = latexmk #only type supported for now is latexmk
+
+ [latexmk]
+path_to_latexmk = /usr/bin/latexmk #optional, defaults to /usr/bin/latexmk
+template = output.outputtest_pdf.tex #should point to a .tex.erb file in the outputs directory
+
===Todo
* enable a 'olsen -init -with-examples' that will create a functioning olsen framework with example ini files, sqlite databases and queries, pdf outputs, formatting filters, etc.
-* provide docs on job and pdf ini-file format
View
2 lib/olsen/version.rb
@@ -1,3 +1,3 @@
class Olsen
- VERSION = "0.0.5"
+ VERSION = "0.0.6"
end

0 comments on commit 616f3a5

Please sign in to comment.