X-Git-Url: https://git.danieliu.xyz/?p=smdp.git;a=blobdiff_plain;f=README.md;h=c05f04ad776d1d1b9112ad55e37866b86882e76f;hp=e6cf4a97c387cfc1da1740cc84279a2de4e3b715;hb=38d6a34dd282abfa10f7d083a3f8161f0649acea;hpb=70ad0f10f8facb86d8df8252526c5d3a7180b9aa diff --git a/README.md b/README.md index e6cf4a9..c05f04a 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,8 @@ 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,9 +20,13 @@ 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 Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program. +- 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: @@ -59,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 @@ -75,4 +80,3 @@ Review sample.md for more details. To make a debug version of `mdp`, just type: $ make DEBUG=1 -