diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 21 insertions, 11 deletions
@@ -1,21 +1,31 @@ +django-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) +Requirements +------------ + +Install the [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) binary. +This requires libfontconfig (on Ububtu: `sudo aptitude install libfontconfig`). + + +Installation +------------ + +Run `pip install django-wkhtmltopdf`. -INSTALLATION -============ +Add `'wkhtmltopdf'` to `INSTALLED_APPS` in your `settings.py`. -Add 'wkhtmltopdf' to INSTALLED_APPS. +By default it will execute the first wkhtmltopdf command found on your `PATH`. -By default it will execute the first wkhtmltopdf command found on your PATH. -You can set WKHTMLTOPDF_CMD to a specific execuatable: +If you can't add wkhtmltopdf to your `PATH`, you can set `WKHTMLTOPDF_CMD` to a +specific execuatable: -e.g. +e.g.: in `settings.py` WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf' |