aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMax Peterson <max@incuna.com>2011-07-11 14:55:54 +0100
committerMax Peterson <max@incuna.com>2011-07-11 14:55:54 +0100
commit3db3101bbfef9b03ec34b96fc4d1cc68ca9c2274 (patch)
tree86e3ea3733ff91548d31763875b7c5387c6d6422 /README
parent7296f34ca950d0ac3f6f7c5326b899ffe75bbef5 (diff)
downloaddjango-wkhtmltopdf-3db3101bbfef9b03ec34b96fc4d1cc68ca9c2274.tar.gz
django-wkhtmltopdf-3db3101bbfef9b03ec34b96fc4d1cc68ca9c2274.tar.bz2
django-wkhtmltopdf-3db3101bbfef9b03ec34b96fc4d1cc68ca9c2274.zip
Updated README
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 21 insertions, 1 deletions
diff --git a/README b/README
index 65e37bb..7ff49df 100644
--- a/README
+++ b/README
@@ -1 +1,21 @@
-Converts html to PDF using http://code.google.com/p/wkhtmltopdf/
+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'