X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=cbf332653aece50ee805e134b085c77e2214a979;hb=bdd26d4dde3b3d3180619cc81622081025ca6cb5;hp=c4a6f2bd28284bb3d393b9f548290799296ebc15;hpb=11bf64f833379a70fc3f9b2adb365312810a26c2;p=smdp.git

diff --git a/README.md b/README.md
index c4a6f2b..cbf3326 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,52 @@
 
-## mpd - A command-line based markdown presentation tool.
+## mdp - A command-line based markdown presentation tool.
+
+![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`
+- 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:*
 
 _Horizontal rulers are used as slide separator._
 
-_Supports basic markdown formatting:_
+_Supports basic markdown formating:_
 
-- line wide formatting
+- line wide formating
     - headlines
     - code
     - quotes
+    - unordered list
 
-- in-line formatting
+- in-line formating
     - bold text
     - underlined text
+    - code
+
+_Supports headers prefixed by @ symbol._
+
+- first two header lines are displayed as title and author
+  in top and bottom bar
+
+_Review sample.md for more details._
 
 ---
 
@@ -36,6 +56,14 @@ _Supports basic markdown formatting:_
   Space, Enter, Backspace - next/previous slide
 - Home - go to first slide
 - End - go to last slide
-- 0-9 - go to slide n
+- 1-9 - go to slide n
 - q - exit
 
+
+---
+
+*How to debug it:*
+
+To make a debug version of `mdp`, just type:
+
+    $ make DEBUG=1