X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=9f9fa4152afea26ed6067d82fe3b4141dd721faa;hb=43a24a661f906c34238df94de5c4ae648f1c8b72;hp=e2f508183c04a3c045867624b794b1c8da76f1cd;hpb=2d505fadada6a9ff939dd30f784ac6419556025f;p=smdp.git diff --git a/README.md b/README.md index e2f5081..9f9fa41 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## mdp - A command-line based markdown presentation tool. -![image](https://cloud.githubusercontent.com/assets/2237222/4280231/d63178fa-3d2a-11e4-88a6-2b8e3608c4ca.gif) +![image](https://cloud.githubusercontent.com/assets/2237222/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.gif) --- @@ -9,8 +9,9 @@ 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` +- on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev` Now download and install mdp: @@ -20,8 +21,12 @@ Now download and install mdp: $ make install $ 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 Arch, you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/). +- On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`. +- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp). +- On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`. +- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`. +- On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`. Most terminals support 256 colors only if the TERM variable is set correctly. To enjoy mdp's color fading feature: @@ -58,12 +63,13 @@ Review sample.md for more details. ***Controls:*** -- h, j, k, l, Cursor keys, +- h, j, k, l, Arrow keys, 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 +- r - reload input file - q - exit @@ -74,4 +80,3 @@ Review sample.md for more details. To make a debug version of `mdp`, just type: $ make DEBUG=1 -