commit 0aeec769bd328d31525dbb2d386773fe6dbd42ba from: Marcel Rodrigues date: Fri Nov 07 22:49:13 2014 UTC Additions to README. commit - cc8a22df1ef2f70da2cd4ed5e38669abe8527f28 commit + 0aeec769bd328d31525dbb2d386773fe6dbd42ba blob - 2409b7a6bf57b9728de342bb121fd943ce7bf684 blob + ed04c19fada06f4c6fc38af6774a96d5c692d885 --- README.md +++ README.md @@ -44,13 +44,33 @@ Quick Start ``` +Dependencies +============ + + Rover is supposed to run on any Unix-like system with a curses implementation. +To build Rover, you need a C89 compiler and a `curses.h` header file. + Configuration ============= Rover configuration (mostly key bindings and colors) can only be changed -by editing config.h and rebuilding the binary. +by editing the file `config.h` and rebuilding the binary. + Note that the external programs executed by some Rover commands may be changed +via the appropriated environment variables. For example, to specify an editor: + ``` + $ EDITOR=vi ./rover + ``` + You may also want to "install" Rover by copying it somewhere on your $PATH. The +only file that needs to be copied is `rover`: + ``` + $ cp rover /usr/bin + $ # Now the "./" prefix is no longer necessary + $ rover + ``` + + Copyright =========