From c6fd6e2854e9dc388e2305d3bf3066649644494c Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 26 Apr 2017 14:21:46 +0100 Subject: [PATCH] Add installation documentation --- docs/installation.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index e69de29..3effefd 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -0,0 +1,34 @@ +# Installation + +### Installing dependencies +These applications will not be installed with `md-pdf`, so need to be installed through your OS's package manager. +- `pandoc` +- `pandoc-citeproc` +- `wkhtmltopdf` (With QT - [See Here](https://pypi.python.org/pypi/pdfkit)) + + +#### Arch Linux + yaourt -S pandoc pandoc-citeproc wkhtmltopdf-static + +#### Ubuntu + sudo apt install pandoc pandoc-citeproc + +To install the correct version of `wkhtmltopdf`, you will need to build it yourself using [this script](https://github.com/JazzCore/python-pdfkit/blob/master/travis/before-script.sh). + +#### Windows +__Note__: Windows is an untested platform, these installation instructions are only theoretical! + +Pandoc (and `pandoc-citeproc`) can be installed using the installer found [here](https://github.com/jgm/pandoc/releases/). + +`wkhtmltopdf` can be installed from the [official website](https://wkhtmltopdf.org/downloads.html). + + +### Installing `md-pdf`. +This application isn't available through Pypi directly, but can still be installed using pip. + + pip install https://github.com/RealOrangeOne/md-pdf + +This should install the rest of the dependencies. To check it installed correctly, you can run this: + + mdp --help +If you see the help information, it's installed correctly. If not, please submit an [issue](https://github.com/RealOrangeOne/md-pdf).