README.md

   1
   2 ## mpd - A command-line based markdown presentation tool.
   3
   4 ---
   5
   6 *How to get started:*
   7
   8     $ git clone https://github.com/visit1985/mdp.git
   9     $ cd mdp
  10     $ make
  11     $ make install
  12     $ mdp sample.md
  13
  14 ---
  15
  16 *How to use it:*
  17
  18 _Horizontal rulers are used as slide separator._
  19
  20 _Supports basic markdown formatting:_
  21
  22 - line wide formatting
  23     - headlines
  24     - code
  25     - quotes
  26
  27 - in-line formatting
  28     - bold text
  29     - underlined text
  30
  31 ---
  32
  33 *Controls:*
  34
  35 - h, j, k, l, Cursor keys,
  36   Space, Enter, Backspace - next/previous slide
  37 - Home - go to first slide
  38 - End - go to last slide
  39 - 0-9 - go to slide n
  40 - q - exit
  41