X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=8c099760344c532699248cd70d6ec3e1d400f134;hb=96277f3ca3bb80c44eb559b782cdd7044cd71514;hp=9f9fa4152afea26ed6067d82fe3b4141dd721faa;hpb=43a24a661f906c34238df94de5c4ae648f1c8b72;p=smdp.git diff --git a/README.md b/README.md index 9f9fa41..8c09976 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ mdp needs the ncursesw headers to compile. So make sure you have them installed: -- on Cygwin you need `libncursesw10` and `libncurses-devel` - on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev` Now download and install mdp: @@ -21,7 +20,8 @@ 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 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`. @@ -29,7 +29,7 @@ Now download and install 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: +set correctly: $ export TERM=xterm-256color @@ -61,7 +61,7 @@ Review sample.md for more details. --- -***Controls:*** +***Default controls:*** - h, j, k, l, Arrow keys, Space, Enter, Backspace, @@ -73,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:***