X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=cbf332653aece50ee805e134b085c77e2214a979;hb=618df4fd72bc78c3012a0987ab9e7183a404b20c;hp=226dbc4727006ac17893bc39f1941c4676c0fab7;hpb=0e5c847bb93a92d66bdee6cd6f0c22146123e2aa;p=smdp.git diff --git a/README.md b/README.md index 226dbc4..cbf3326 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,21 @@ *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` +- on Cygwin you need `libncursesw10` and `libncurses-devel` + +Now download and install mdp: + $ git clone https://github.com/visit1985/mdp.git $ cd mdp $ make $ make install $ mdp sample.md +- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/). + --- *How to use it:* @@ -25,10 +34,12 @@ _Supports basic markdown formating:_ - headlines - code - quotes + - unordered list - in-line formating - bold text - underlined text + - code _Supports headers prefixed by @ symbol._ @@ -48,3 +59,11 @@ _Review sample.md for more details._ - 1-9 - go to slide n - q - exit + +--- + +*How to debug it:* + +To make a debug version of `mdp`, just type: + + $ make DEBUG=1