From d408c74465c4903f9172bfdeb626a52692eda1be Mon Sep 17 00:00:00 2001 From: Tomas Barton Date: Thu, 11 Feb 2016 14:59:45 +0100 Subject: [PATCH] add travis badge, code formatting, updated compilation instructions --- README | 59 +++++++++++++++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 23 deletions(-) diff --git a/README b/README index 3bc17a4b..9151d21f 100644 --- a/README +++ b/README @@ -1,50 +1,63 @@ +[![Build Status](https://travis-ci.org/hishamhm/htop.svg?branch=master)](https://travis-ci.org/hishamhm/htop) htop ==== -by Hisham Muhammad - -2004 - 2015 +by Hisham Muhammad (2004 - 2016) Introduction ------------ -This is htop, an interactive process viewer. -It requires ncurses. It is developed primarily on Linux, +This is `htop`, an interactive process viewer. +It requires `ncurses`. It is developed primarily on Linux, but we also have code for running under FreeBSD and Mac OS X (help and testing are wanted for these platforms!) This software has evolved considerably over the years, and is reasonably complete, but there is always room for improvement. -Comparison between 'htop' and classic 'top' +Comparison between `htop` and classic `top` ------------------------------------------- -* In 'htop' you can scroll the list vertically and horizontally +* In `htop` you can scroll the list vertically and horizontally to see all processes and full command lines. -* In 'top' you are subject to a delay for each unassigned +* In `top` you are subject to a delay for each unassigned key you press (especially annoying when multi-key escape sequences are triggered by accident). -* 'htop' starts faster ('top' seems to collect data for a while +* `htop` starts faster (`top` seems to collect data for a while before displaying anything). -* In 'htop' you don't need to type the process number to - kill a process, in 'top' you do. -* In 'htop' you don't need to type the process number or - the priority value to renice a process, in 'top' you do. -* In 'htop' you can kill multiple processes at once. -* 'top' is older, hence, more tested. +* In `htop` you don't need to type the process number to + kill a process, in `top` you do. +* In `htop` you don't need to type the process number or + the priority value to renice a process, in `top` you do. +* In `htop` you can kill multiple processes at once. +* `top` is older, hence, more tested. Compilation instructions ------------------------ This program is distributed as a standard autotools-based package. -See the INSTALL file for detailed instructions, but you are -probably used to the common `./configure`/`make`/`make install` routine. +See the [INSTALL](/INSTALL) file for detailed instructions, but you are +probably used to the common routine: -When fetching the code from the development repository, you need -to run the `./autogen.sh` script, which in turn requires autotools -to be installed. + ./autogen.sh && ./configure && make -See the manual page (man htop) or the on-line help ('F1' or 'h' -inside htop) for a list of supported key commands. +If you want to replace currently installed version of `htop` use `--prefix` flag. `--prefix=/usr` +will install `htop` into `/usr/bin/htop`. -if not all keys work check your curses configuration. + ./autogen.sh && ./configure --prefix=/usr && make + make install + +See the manual page (`man htop`) or the on-line help ('F1' or 'h' +inside `htop`) for a list of supported key commands. + +If not all keys work check your curses configuration. + +### Prerequisites + +#### Debian/Ubuntu + + apt-get install build-essential libncursesw5-dev autotools-dev + +## License + +GNU General Public License, version 2 (GPL-2.0)