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/Debian you need `libncursesw5` and `libncursesw5-dev`
  13 - on Cygwin you need `libncursesw10` and `libncurses-devel`
  14
  15 Now 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
  25 ---
  26
  27 *How to use it:*
  28
  29 _Horizontal rulers are used as slide separator._
  30
  31 _Supports basic markdown formating:_
  32
  33 - line wide formating
  34     - headlines
  35     - code
  36     - quotes
  37
  38 - in-line formating
  39     - bold text
  40     - underlined text
  41
  42 _Supports headers prefixed by @ symbol._
  43
  44 - first two header lines are displayed as title and author
  45   in top and bottom bar
  46
  47 _Review sample.md for more details._
  48
  49 ---
  50
  51 *Controls:*
  52
  53 - h, j, k, l, Cursor keys,
  54   Space, Enter, Backspace - next/previous slide
  55 - Home - go to first slide
  56 - End - go to last slide
  57 - 1-9 - go to slide n
  58 - q - exit
  59
  60
  61 ---
  62
  63 *How to debug it:*
  64
  65 To make a debug version of `mdp`, just type:
  66
  67     $ make DEBUG=1