From aa5c95912010f76445e547938059624eddb339d1 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 26 Apr 2017 12:34:29 +0100 Subject: [PATCH] Add installation instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index bf87661..d13f7a6 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,18 @@ Convert markdown files into PDF Documents. __Note__: All features are completely optional +### Installation +This library isn't on Pypi, but can still be installed using pip: + + pip install https://github.com/RealOrangeOne/md-pdf + +Additionally, you will need the following programs: +- `wkhtmltopdf` (With QT - [See Here](https://pypi.python.org/pypi/pdfkit)) +- `pandoc` +- `pandoc-siteproc` + +These packages should be available on most linux distributions, OSX and Windows support is untested! + ### Usage $ mdp --help usage: mdp [-h] [-v] [--update-csl]