-## mpd - A command-line based markdown presentation tool.
+## mdp - A command-line based markdown presentation tool.
+
+
---
*How to get started:*
+mdp needs the ncursesw headers to compile.
+So make sure you have them installed:
+- on Ubuntu/Debian you need `libncursesw5` and `libncursesw5-dev`
+- on Cygwin you need `libncursesw10` and `libncurses-devel`
+
+Now download and install mdp:
+
$ git clone https://github.com/visit1985/mdp.git
$ cd mdp
$ make
$ make install
$ mdp sample.md
+- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
+
---
*How to use it:*
_Horizontal rulers are used as slide separator._
-_Supports basic markdown formatting:_
+_Supports basic markdown formating:_
-- line wide formatting
+- line wide formating
- headlines
- code
- quotes
+ - unordered list
-- in-line formatting
+- in-line formating
- bold text
- underlined text
+ - code
+
+_Supports headers prefixed by @ symbol._
+
+- first two header lines are displayed as title and author
+ in top and bottom bar
+
+_Review sample.md for more details._
---
Space, Enter, Backspace - next/previous slide
- Home - go to first slide
- End - go to last slide
-- 0-9 - go to slide n
+- 1-9 - go to slide n
- q - exit
+
+---
+
+*How to debug it:*
+
+To make a debug version of `mdp`, just type:
+
+ $ make DEBUG=1
