README.md

   1
   2 ## mdp - A command-line based markdown presentation tool.
   3
   4 ![image](https://cloud.githubusercontent.com/assets/2237222/4264047/62cc07b8-3c12-11e4-8710-f2e5959200c8.png)
   5
   6 ---
   7
   8 *How to get started:*
   9
  10     $ git clone https://github.com/visit1985/mdp.git
  11     $ cd mdp
  12     $ make
  13     $ make install
  14     $ mdp sample.md
  15
  16 ---
  17
  18 *How to use it:*
  19
  20 _Horizontal rulers are used as slide separator._
  21
  22 _Supports basic markdown formating:_
  23
  24 - line wide formating
  25     - headlines
  26     - code
  27     - quotes
  28
  29 - in-line formating
  30     - bold text
  31     - underlined text
  32
  33 _Supports headers prefixed by @ symbol._
  34
  35 - first two header lines are displayed as title and author
  36   in top and bottom bar
  37
  38 _Review sample.md for more details._
  39
  40 ---
  41
  42 *Controls:*
  43
  44 - h, j, k, l, Cursor keys,
  45   Space, Enter, Backspace - next/previous slide
  46 - Home - go to first slide
  47 - End - go to last slide
  48 - 1-9 - go to slide n
  49 - q - exit
  50