aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ff49df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+Converts html to PDF
+====================
+
+Provides a thin wrapper to the wkhtmltopdf binary from http://code.google.com/p/wkhtmltopdf/
+
+REQUIREMENTS
+============
+
+Install the binary http://code.google.com/p/wkhtmltopdf/
+ This may require libfontconfig (on Ububtu: sudo aptitude install libfontconfig)
+
+INSTALLATION
+============
+
+Add 'wkhtmltopdf' to INSTALLED_APPS.
+
+By default it will execute the first wkhtmltopdf command found on your PATH.
+You can set WKHTMLTOPDF_CMD to a specific execuatable:
+
+e.g.
+ WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf'