removed alpha warning

[smdp.git] / README.md

diff --git a/README.md b/README.md
index c4a6f2b..136ec44 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
 
-## mpd - A command-line based markdown presentation tool.
+## mdp - A command-line based markdown presentation tool.
+
+![image](https://cloud.githubusercontent.com/assets/2237222/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.gif)
 
 ---
 
-*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`
+- on Cygwin you need `libncursesw10` and `libncurses-devel`
+
+Now download and install mdp:
 
     $ git clone https://github.com/visit1985/mdp.git
     $ cd mdp
@@ -11,31 +20,61 @@
     $ make install
     $ 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`.
+- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
+- On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install 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 formatting:_
+Supports basic markdown formating:
 
-- line wide formatting
+- line wide markup
     - headlines
     - code
     - quotes
+    - unordered list
 
-- in-line formatting
+- in-line markup
     - 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.
 
 ---
 
-*Controls:*
+***Controls:***
 
-- h, j, k, l, Cursor keys,
-  Space, Enter, Backspace - next/previous slide
-- Home - go to first slide
-- End - go to last slide
-- 0-9 - go to slide n
+- h, j, k, l, Arrow keys,
+    Space, Enter, Backspace,
+    Page Up, Page Down - next/previous slide
+- Home, g - go to first slide
+- End, G - go to last slide
+- 1-9 - go to slide n
+- r - reload input file
 - q - exit
 
+
+---
+
+***How to debug it:***
+
+To make a debug version of `mdp`, just type:
+
+    $ make DEBUG=1
+