README.md

   1
   2 ## mdp - A command-line based markdown presentation tool.
   3
   4 ![image](https://cloud.githubusercontent.com/assets/2237222/4280231/d63178fa-3d2a-11e4-88a6-2b8e3608c4ca.gif)
   5
   6 ---
   7
   8 *How to get started:*
   9
  10 mdp needs the ncursesw headers to compile.
  11 So make sure you have them installed:
  12 - On Ubuntu you need ```libncursesw5``` and ```libncursesw5-dev``` to be installed.
  13
  14 Now download and install mdp:
  15
  16     $ git clone https://github.com/visit1985/mdp.git
  17     $ cd mdp
  18     $ make
  19     $ make install
  20     $ mdp sample.md
  21
  22 - On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
  23
  24 ---
  25
  26 *How to use it:*
  27
  28 _Horizontal rulers are used as slide separator._
  29
  30 _Supports basic markdown formating:_
  31
  32 - line wide formating
  33     - headlines
  34     - code
  35     - quotes
  36
  37 - in-line formating
  38     - bold text
  39     - underlined text
  40
  41 _Supports headers prefixed by @ symbol._
  42
  43 - first two header lines are displayed as title and author
  44   in top and bottom bar
  45
  46 _Review sample.md for more details._
  47
  48 ---
  49
  50 *Controls:*
  51
  52 - h, j, k, l, Cursor keys,
  53   Space, Enter, Backspace - next/previous slide
  54 - Home - go to first slide
  55 - End - go to last slide
  56 - 1-9 - go to slide n
  57 - q - exit
  58
  59
  60 ---
  61
  62 *How to debug it:*
  63
  64 To make a debug version of `mdp`, just type:
  65
  66     $ make DEBUG=1