pinosaur
/
smdp.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add support for bool type.
[smdp.git]
/
README.md
diff --git
a/README.md
b/README.md
index
c4a6f2b
..
cbf3326
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,32
+1,52
@@
-## mpd - A command-line based markdown presentation tool.
+## mdp - A command-line based markdown presentation tool.
+
+![image](https://cloud.githubusercontent.com/assets/2237222/4280231/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:*
_Horizontal rulers are used as slide separator._
---
*How to use it:*
_Horizontal rulers are used as slide separator._
-_Supports basic markdown format
t
ing:_
+_Supports basic markdown formating:_
-- line wide format
t
ing
+- line wide formating
- headlines
- code
- quotes
- headlines
- code
- quotes
+ - unordered list
-- in-line format
t
ing
+- in-line formating
- bold text
- underlined text
- bold text
- underlined text
+ - code
+
+_Supports headers prefixed by @ symbol._
+
+- first two header lines are displayed as title and author
+ in top and bottom bar
+
+_Review sample.md for more details._
---
---
@@
-36,6
+56,14
@@
_Supports basic markdown formatting:_
Space, Enter, Backspace - next/previous slide
- Home - go to first slide
- End - go to last slide
Space, Enter, Backspace - next/previous slide
- Home - go to first slide
- End - go to last slide
--
0
-9 - go to slide n
+-
1
-9 - go to slide n
- q - exit
- q - exit
+
+---
+
+*How to debug it:*
+
+To make a debug version of `mdp`, just type:
+
+ $ make DEBUG=1