From c15e24a4e744ba43208b9f4f4f4af1f4774ad989 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 26 Apr 2017 13:24:08 +0100 Subject: [PATCH] Move documentation into directory --- README.md | 13 ++----------- docs/installation.md | 0 docs/referencing.md | 1 + 3 files changed, 3 insertions(+), 11 deletions(-) create mode 100644 docs/installation.md create mode 100644 docs/referencing.md diff --git a/README.md b/README.md index d13f7a6..eb95f74 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,8 @@ 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! +### Documentation +Documentation can be found in the `docs/` directory. ### Usage $ mdp --help diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/referencing.md b/docs/referencing.md new file mode 100644 index 0000000..81b6887 --- /dev/null +++ b/docs/referencing.md @@ -0,0 +1 @@ +# Referencing