X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=c4b00725418e7ee4e7d71307407b2a135a1b379c;hb=60f4f976c4f4743ff299dcc3a92c0b9f86d8bbc3;hp=5491c817652011262244d0b4970b5d6a91081ec7;hpb=a3b238891b31760396634d1c81691af439337f4d;p=smdp.git diff --git a/README.md b/README.md index 5491c81..c4b0072 100644 --- 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,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`. @@ -60,7 +61,7 @@ Review sample.md for more details. --- -***Controls:*** +***Default controls:*** - h, j, k, l, Arrow keys, Space, Enter, Backspace, @@ -72,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:***