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
  13 - on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev`
  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 Linux, you can use the existing [package](https://www.archlinux.org/packages/community/x86_64/mdp/).
  24 - on Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program.
  25 - On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`.
  26 - On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
  27 - On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`.
  28 - On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
  29 - On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`.
  30
  31 Most terminals support 256 colors only if the TERM variable is
  32 set correctly:
  33
  34     $ export TERM=xterm-256color
  35
  36 ---
  37
  38 ***How to use it:***
  39
  40 Horizontal rulers are used as slide separator.
  41
  42 Supports basic markdown formating:
  43
  44 - line wide markup
  45     - headlines
  46     - code
  47     - quotes
  48     - unordered list
  49
  50 - in-line markup
  51     - bold text
  52     - underlined text
  53     - code
  54
  55 Supports headers prefixed by @ symbol.
  56
  57 - first two header lines are displayed as title and author
  58     in top and bottom bar
  59
  60 Review sample.md for more details.
  61
  62 ---
  63
  64 ***Default controls:***
  65
  66 - h, j, k, l, Arrow keys,
  67     Space, Enter, Backspace,
  68     Page Up, Page Down - next/previous slide
  69 - Home, g - go to first slide
  70 - End, G - go to last slide
  71 - 1-9 - go to slide n
  72 - r - reload input file
  73 - q - exit
  74
  75
  76 ---
  77
  78 ***Configuration***:
  79
  80 A `config.h` configuration file is available in `include/`, change the settings you want and recompile.
  81 Colors, keybindings and list types are configurable as of now. Note that configuring colors only works in 8 color mode.
  82
  83 ---
  84
  85 ***How to debug it:***
  86
  87 To make a debug version of `mdp`, just type:
  88
  89     $ make DEBUG=1