Merge pull request #23 from mattn/win32

[smdp.git] / README.md

diff --git a/README.md b/README.md
index ce9da7d..75f638e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,26 @@
 
 ## mdp - A command-line based markdown presentation tool.
 
-![image](https://cloud.githubusercontent.com/assets/2237222/4264047/62cc07b8-3c12-11e4-8710-f2e5959200c8.png)
+![image](https://cloud.githubusercontent.com/assets/2237222/4280231/d63178fa-3d2a-11e4-88a6-2b8e3608c4ca.gif)
 
 ---
 
 *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.
+
+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