From 0540b857306c39e5f7077cc6b7a8eebf51448935 Mon Sep 17 00:00:00 2001 From: Charlie Denton Date: Fri, 24 Feb 2012 10:06:52 +0000 Subject: Add changelog and rename readme. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md (limited to 'README.md') 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' -- cgit v1.2.3 From f1c26baeddb539d5eecdb8cb8d41eb723f5205e2 Mon Sep 17 00:00:00 2001 From: Charlie Denton Date: Fri, 24 Feb 2012 10:28:10 +0000 Subject: Touched up README. --- README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7ff49df..219d4e1 100644 --- a/README.md +++ b/README.md @@ -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' -- cgit v1.2.3