X-Git-Url: https://git.danieliu.xyz/?p=smdp.git;a=blobdiff_plain;f=README.md;h=136ec44fcd88753b74d823fe2b0e755d3649c87b;hp=027b59b3c164e8429da2cd12d91b66818da1214c;hb=22055d604b1207680ded02d98715df5cafdf8648;hpb=3055b6d15234fe12f088e33747aae945dbb9896a diff --git a/README.md b/README.md index 027b59b..136ec44 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ ## 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) --- -*How to get started:* +***How to get started:*** mdp needs the ncursesw headers to compile. So make sure you have them installed: @@ -20,48 +20,61 @@ 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 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). +- On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`. + +Most terminals support 256 colors only if the TERM variable is +set correctly. To enjoy mdp's color fading feature: + + $ export TERM=xterm-256color --- -*How to use it:* +***How to use it:*** -_Horizontal rulers are used as slide separator._ +Horizontal rulers are used as slide separator. -_Supports basic markdown formating:_ +Supports basic markdown formating: -- line wide formating +- line wide markup - headlines - code - quotes + - unordered list -- in-line formating +- in-line markup - bold text - underlined text + - code -_Supports headers prefixed by @ symbol._ +Supports headers prefixed by @ symbol. - first two header lines are displayed as title and author - in top and bottom bar + in top and bottom bar -_Review sample.md for more details._ +Review sample.md for more details. --- -*Controls:* +***Controls:*** -- h, j, k, l, Cursor keys, - Space, Enter, Backspace - next/previous slide -- Home - go to first slide -- End - go to last slide +- h, j, k, l, Arrow keys, + Space, Enter, Backspace, + Page Up, Page Down - next/previous 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 --- -*How to debug it:* +***How to debug it:*** To make a debug version of `mdp`, just type: $ make DEBUG=1 +