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 Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install 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 - On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
  28 - On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`.
  29
  30 Most terminals support 256 colors only if the TERM variable is
  31 set correctly. To enjoy mdp's color fading feature:
  32
  33     $ export TERM=xterm-256color
  34
  35 ---
  36
  37 ***How to use it:***
  38
  39 Horizontal rulers are used as slide separator.
  40
  41 Supports basic markdown formating:
  42
  43 - line wide markup
  44     - headlines
  45     - code
  46     - quotes
  47     - unordered list
  48
  49 - in-line markup
  50     - bold text
  51     - underlined text
  52     - code
  53
  54 Supports headers prefixed by @ symbol.
  55
  56 - first two header lines are displayed as title and author
  57     in top and bottom bar
  58
  59 Review sample.md for more details.
  60
  61 ---
  62
  63 ***Controls:***
  64
  65 - h, j, k, l, Arrow keys,
  66     Space, Enter, Backspace,
  67     Page Up, Page Down - next/previous slide
  68 - Home, g - go to first slide
  69 - End, G - go to last slide
  70 - 1-9 - go to slide n
  71 - r - reload input file
  72 - q - exit
  73
  74
  75 ---
  76
  77 ***How to debug it:***
  78
  79 To make a debug version of `mdp`, just type:
  80
  81     $ make DEBUG=1