Add installation instructions
This commit is contained in:
parent
56c55e005b
commit
aa5c959120
1 changed files with 12 additions and 0 deletions
12
README.md
12
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]
|
||||
|
|
Reference in a new issue