1 2## mdp - A command-line based markdown presentation tool. 3 4![image](https://cloud.githubusercontent.com/assets/2237222/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.gif) 5 6--- 7 8***How to get started:*** 9 10mdp needs the ncursesw headers to compile. 11So make sure you have them installed: 12 13- on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev` 14 15Now download and install mdp: 16 17 $ git clone https://github.com/visit1985/mdp.git 18 $ cd mdp 19 $ make 20 $ make install 21 $ mdp sample.md 22 23- On Arch, you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/). 24- on Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program. 25- On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`. 26- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp). 27- On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`. 28- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`. 29- On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`. 30 31Most terminals support 256 colors only if the TERM variable is 32set correctly. To enjoy mdp's color fading feature: 33 34 $ export TERM=xterm-256color 35 36--- 37 38***How to use it:*** 39 40Horizontal rulers are used as slide separator. 41 42Supports basic markdown formating: 43 44- line wide markup 45 - headlines 46 - code 47 - quotes 48 - unordered list 49 50- in-line markup 51 - bold text 52 - underlined text 53 - code 54 55Supports headers prefixed by @ symbol. 56 57- first two header lines are displayed as title and author 58 in top and bottom bar 59 60Review sample.md for more details. 61 62--- 63 64***Controls:*** 65 66- h, j, k, l, Arrow keys, 67 Space, Enter, Backspace, 68 Page Up, Page Down - next/previous slide 69- Home, g - go to first slide 70- End, G - go to last slide 71- 1-9 - go to slide n 72- r - reload input file 73- q - exit 74 75 76--- 77 78***How to debug it:*** 79 80To make a debug version of `mdp`, just type: 81 82 $ make DEBUG=1 83