X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=a5a9e7c8f607da95b4f3a1e774f24554a6fc46e5;hb=2854a2e2ba7bd3c38bb4ebf4213b132a6e2fd882;hp=226dbc4727006ac17893bc39f1941c4676c0fab7;hpb=0e5c847bb93a92d66bdee6cd6f0c22146123e2aa;p=smdp.git diff --git a/README.md b/README.md index 226dbc4..a5a9e7c 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,20 @@ *How to get started:* +mdp needs the ncursesw headers to compile. +So make sure you have them installed: +- On Ubuntu you need ```libncursesw5``` and ```libncursesw5-dev``` to be installed. + +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:* @@ -48,3 +56,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