pinosaur
/
smdp.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge pull request #38 from FreeBirdLjj/issue#16
[smdp.git]
/
README.md
diff --git
a/README.md
b/README.md
index
ce9da7d
..
cbf3326
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,18
+1,27
@@
## mdp - A command-line based markdown presentation tool.
## mdp - A command-line based markdown presentation tool.
-![image](https://cloud.githubusercontent.com/assets/2237222/42
64047/62cc07b8-3c12-11e4-8710-f2e5959200c8.png
)
+![image](https://cloud.githubusercontent.com/assets/2237222/42
80231/d63178fa-3d2a-11e4-88a6-2b8e3608c4ca.gif
)
---
*How to get started:*
---
*How to get started:*
+mdp needs the ncursesw headers to compile.
+So make sure you have them installed:
+- on Ubuntu/Debian you need `libncursesw5` and `libncursesw5-dev`
+- on Cygwin you need `libncursesw10` and `libncurses-devel`
+
+Now download and install mdp:
+
$ git clone https://github.com/visit1985/mdp.git
$ cd mdp
$ make
$ make install
$ mdp sample.md
$ git clone https://github.com/visit1985/mdp.git
$ cd mdp
$ make
$ make install
$ mdp sample.md
+- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
+
---
*How to use it:*
---
*How to use it:*
@@
-25,10
+34,12
@@
_Supports basic markdown formating:_
- headlines
- code
- quotes
- headlines
- code
- quotes
+ - unordered list
- in-line formating
- bold text
- underlined text
- in-line formating
- bold text
- underlined text
+ - code
_Supports headers prefixed by @ symbol._
_Supports headers prefixed by @ symbol._
@@
-48,3
+59,11
@@
_Review sample.md for more details._
- 1-9 - go to slide n
- q - exit
- 1-9 - go to slide n
- q - exit
+
+---
+
+*How to debug it:*
+
+To make a debug version of `mdp`, just type:
+
+ $ make DEBUG=1