From 42648d6614bf4db47b6a74795b2611c5963caf38 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 5 Apr 2017 16:24:12 +0100 Subject: [PATCH] Add basic readme --- README.md | 29 +++++++++++++++++++++++++++++ md_pdf/args.py | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf87661 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# MD-PDF + +[![CircleCI](https://img.shields.io/circleci/project/github/RealOrangeOne/md-pdf.svg?style=flat-square)](https://circleci.com/gh/RealOrangeOne/md-pdf/) +[![Github Releases](https://img.shields.io/github/downloads/RealOrangeOne/md-pdf/latest/total.svg?style=flat-square)](https://github.com/RealOrangeOne/md-pdf) + +Convert markdown files into PDF Documents. + +### Features +- Multiple output formats +- Bibliography with 1400+ referencing formats +- Templating support (powered by [`jinja2`](http://jinja.pocoo.org/)) +- Cover pages +- Page numbers in footer +- Student / TurnItIn Number in header / cover + +__Note__: All features are completely optional + + +### Usage + $ mdp --help + usage: mdp [-h] [-v] [--update-csl] + + optional arguments: + -h, --help show this help message and exit + -v, --verbose Set verbosity level (repeat argument) + --update-csl Update CSL files + +### Configuration +An example configuration file can be found [Here](https://github.com/RealOrangeOne/md-pdf/blob/master/test-files/mdp.yml). diff --git a/md_pdf/args.py b/md_pdf/args.py index ac54656..bf5ac06 100644 --- a/md_pdf/args.py +++ b/md_pdf/args.py @@ -3,7 +3,7 @@ import argparse def parse_args(): parser = argparse.ArgumentParser() - parser.add_argument("-v", "--verbose", help="Display verbose output", action="count", default=0) + parser.add_argument("-v", "--verbose", help="Set verbosity level (repeat argument)", action="count", default=0) parser.add_argument("--update-csl", help="Update CSL files", action="store_true") parser.add_help = True return parser.parse_args()