2 ## mdp - A command-line based markdown presentation tool.
4 ![image](https://cloud.githubusercontent.com/assets/2237222/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.gif)
8 ***How to get started:***
10 mdp needs the ncursesw headers to compile.
11 So make sure you have them installed:
12 - on Cygwin you need `libncursesw10` and `libncurses-devel`
14 Now download and install mdp:
16 $ git clone https://github.com/visit1985/mdp.git
22 - On Arch, you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
23 - On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`.
24 - On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
25 - On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`.
26 - On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
27 - On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`.
29 Most terminals support 256 colors only if the TERM variable is
30 set correctly. To enjoy mdp's color fading feature:
32 $ export TERM=xterm-256color
38 Horizontal rulers are used as slide separator.
40 Supports basic markdown formating:
53 Supports headers prefixed by @ symbol.
55 - first two header lines are displayed as title and author
58 Review sample.md for more details.
64 - h, j, k, l, Arrow keys,
65 Space, Enter, Backspace,
66 Page Up, Page Down - next/previous slide
67 - Home, g - go to first slide
68 - End, G - go to last slide
70 - r - reload input file
76 ***How to debug it:***
78 To make a debug version of `mdp`, just type: