pinosaur
/
smdp.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add first man-page documentation
[smdp.git]
/
README.md
diff --git
a/README.md
b/README.md
index
bfe5197
..
dd03fec
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,7
+1,7
@@
## mdp - 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-2b8e3608c4c
a.gif)
+![image](https://cloud.githubusercontent.com/assets/2237222/
5810237/797c494c-a043-11e4-9dbd-959cab4055f
a.gif)
---
---
@@
-21,6
+21,8
@@
Now download and install mdp:
$ mdp sample.md
- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
$ mdp sample.md
- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
+- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`
+- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
Most terminals support 256 colors only if the TERM variable is
set correctly. To enjoy mdp's color fading feature:
Most terminals support 256 colors only if the TERM variable is
set correctly. To enjoy mdp's color fading feature:
@@
-57,12
+59,13
@@
Review sample.md for more details.
***Controls:***
***Controls:***
-- h, j, k, l,
Cursor
keys,
+- h, j, k, l,
Arrow
keys,
Space, Enter, Backspace,
Page Up, Page Down - next/previous slide
Space, Enter, Backspace,
Page Up, Page Down - next/previous slide
-- Home - go to first slide
-- End - go to last slide
+- Home
, g
- go to first slide
+- End
, G
- go to last slide
- 1-9 - go to slide n
- 1-9 - go to slide n
+- r - reload input file
- q - exit
- q - exit