README.md

   1
   2 ## mdp - A command-line based markdown presentation tool.
   3
   4 ![image](https://cloud.githubusercontent.com/assets/2237222/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.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 - On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
  25 - On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
  26 - On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`.
  27
  28 Most terminals support 256 colors only if the TERM variable is
  29 set correctly. To enjoy mdp's color fading feature:
  30
  31     $ export TERM=xterm-256color
  32
  33 ---
  34
  35 ***How to use it:***
  36
  37 Horizontal rulers are used as slide separator.
  38
  39 Supports basic markdown formating:
  40
  41 - line wide markup
  42     - headlines
  43     - code
  44     - quotes
  45     - unordered list
  46
  47 - in-line markup
  48     - bold text
  49     - underlined text
  50     - code
  51
  52 Supports headers prefixed by @ symbol.
  53
  54 - first two header lines are displayed as title and author
  55     in top and bottom bar
  56
  57 Review sample.md for more details.
  58
  59 ---
  60
  61 ***Controls:***
  62
  63 - h, j, k, l, Arrow keys,
  64     Space, Enter, Backspace,
  65     Page Up, Page Down - next/previous slide
  66 - Home, g - go to first slide
  67 - End, G - go to last slide
  68 - 1-9 - go to slide n
  69 - r - reload input file
  70 - q - exit
  71
  72
  73 ---
  74
  75 ***How to debug it:***
  76
  77 To make a debug version of `mdp`, just type:
  78
  79     $ make DEBUG=1
  80