X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=e2f508183c04a3c045867624b794b1c8da76f1cd;hb=2d505fadada6a9ff939dd30f784ac6419556025f;hp=75f638edda44e01122e3b405c57e13020c0844cc;hpb=02de567610f7c582e5618e75970b40e4802b005e;p=smdp.git diff --git a/README.md b/README.md index 75f638e..e2f5081 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,12 @@ --- -*How to get started:* +***How to get started:*** mdp needs the ncursesw headers to compile. So make sure you have them installed: -- On Ubuntu/Debian you need `libncursesw5` and `libncursesw5-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,37 +21,46 @@ 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` + +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 + 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 @@ -59,8 +69,9 @@ _Review sample.md for more details._ --- -*How to debug it:* +***How to debug it:*** To make a debug version of `mdp`, just type: $ make DEBUG=1 +