X-Git-Url: https://git.danieliu.xyz/?p=smdp.git;a=blobdiff_plain;f=README.md;h=4742ea12aed0505203d10134f99e6846f7bbd73f;hp=c7b10cf9ff92b8e6c600740b3fc9b3f89e6fb5ed;hb=6d627bac82f84e39beda51981ddf3a6ddabbbe78;hpb=79a724e6d9cb5397d6861145fb0a22b0a22d9dcd diff --git a/README.md b/README.md index c7b10cf..4742ea1 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ ## 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 ncurses headers to compile. +mdp needs the ncursesw headers to compile. So make sure you have them installed: -- On Ubuntu you need ```libncurses5``` and ```libncurses5-dev``` to be installed. +- on Ubuntu/Debian you need `libncursesw5` and `libncursesw5-dev` +- on Cygwin you need `libncursesw10` and `libncurses-devel` Now download and install mdp: @@ -20,47 +21,59 @@ Now download and install mdp: $ 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: + + $ 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 +- 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 - 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 +