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 Ubuntu/Debian you need `libncursesw5` and `libncursesw5-dev`
13 - on Cygwin you need `libncursesw10` and `libncurses-devel`
15 Now download and install mdp:
17 $ git clone https://github.com/visit1985/mdp.git
23 - On Arch, you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
24 - On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
25 - On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
26 - On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`.
28 Most terminals support 256 colors only if the TERM variable is
29 set correctly. To enjoy mdp's color fading feature:
31 $ export TERM=xterm-256color
37 Horizontal rulers are used as slide separator.
39 Supports basic markdown formating:
52 Supports headers prefixed by @ symbol.
54 - first two header lines are displayed as title and author
57 Review sample.md for more details.
63 - h, j, k, l, Arrow keys,
64 Space, Enter, Backspace,
65 Page Up, Page Down - next/previous slide
66 - Home, g - go to first slide
67 - End, G - go to last slide
69 - r - reload input file
75 ***How to debug it:***
77 To make a debug version of `mdp`, just type: