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