config.h file
[smdp.git] / README.md
index dd03fec..c4b0072 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@
 
 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`
+
+- on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev`
 
 Now download and install mdp:
 
@@ -20,9 +20,13 @@ Now download and install mdp:
     $ 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 Arch Linux, you can use the existing [package](https://www.archlinux.org/packages/community/x86_64/mdp/).
+- on Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program.
+- On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install 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`.
+- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
+- On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`.
 
 Most terminals support 256 colors only if the TERM variable is
 set correctly. To enjoy mdp's color fading feature:
@@ -57,7 +61,7 @@ Review sample.md for more details.
 
 ---
 
-***Controls:***
+***Default controls:***
 
 - h, j, k, l, Arrow keys,
     Space, Enter, Backspace,
@@ -69,6 +73,13 @@ Review sample.md for more details.
 - q - exit
 
 
+---
+
+***Configuration***:
+
+A `config.h` configuration file is available in `include/`, change the settings you want and recompile.
+Colors, keybindings and list types are configurable as of now. Note that configuring colors only works in 8 color mode.
+
 ---
 
 ***How to debug it:***
@@ -76,4 +87,3 @@ Review sample.md for more details.
 To make a debug version of `mdp`, just type:
 
     $ make DEBUG=1
-