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