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 Most terminals support 256 colors only if the TERM variable is
  26 set correctly. To enjoy mdp's color fading feature:
  27
  28     $ export TERM=xterm-256color
  29
  30 ---
  31
  32 ***How to use it:***
  33
  34 Horizontal rulers are used as slide separator.
  35
  36 Supports basic markdown formating:
  37
  38 - line wide markup
  39     - headlines
  40     - code
  41     - quotes
  42     - unordered list
  43
  44 - in-line markup
  45     - bold text
  46     - underlined text
  47     - code
  48
  49 Supports headers prefixed by @ symbol.
  50
  51 - first two header lines are displayed as title and author
  52     in top and bottom bar
  53
  54 Review sample.md for more details.
  55
  56 ---
  57
  58 ***Controls:***
  59
  60 - h, j, k, l, Cursor keys,
  61     Space, Enter, Backspace,
  62     Page Up, Page Down - next/previous slide
  63 - Home - go to first slide
  64 - End - go to last slide
  65 - 1-9 - go to slide n
  66 - q - exit
  67
  68
  69 ---
  70
  71 ***How to debug it:***
  72
  73 To make a debug version of `mdp`, just type:
  74
  75     $ make DEBUG=1
  76