htop/README

# [![htop](htop.png)](https://htop.dev)

[![CI](https://github.com/htop-dev/htop/workflows/CI/badge.svg)](https://github.com/htop-dev/htop/actions)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/21665/badge.svg)](https://scan.coverity.com/projects/21665)
[![Mailing List](https://img.shields.io/badge/Mailing%20List-htop-blue.svg)](https://groups.io/g/htop)
[![IRC #htop](https://img.shields.io/badge/IRC-htop-blue.svg)](https://webchat.freenode.net/#htop)
[![Github Release](https://img.shields.io/github/release/htop-dev/htop.svg)](https://github.com/htop-dev/htop/releases/latest)
[![Download](https://api.bintray.com/packages/htop/source/htop/images/download.svg)](https://bintray.com/htop/source/htop/_latestVersion)

## Introduction

`htop` is a cross-platform interactive process viewer.
It requires `ncurses`.

For more information and details on how to contribute to `htop`
visit [htop.dev](https://htop.dev).

## Build instructions

This program is distributed as a standard autotools-based package.
For detailed instructions see the [INSTALL](/INSTALL) file, which
is created after `./autogen.sh` is run.

When compiling from a [release tarball](https://github.com/htop-dev/htop/releases/), run:

~~~ shell
./configure && make
~~~

For compiling sources downloaded from the Git repository, run:

~~~ shell
./autogen.sh && ./configure && make
~~~

By default `make install` will install into `/usr/local`, for changing
the path use `./configure --prefix=/some/path`.

See the manual page (`man htop`) or the on-line help ('F1' or 'h'
inside `htop`) for a list of supported key commands.

## License

GNU General Public License, version 2 (GPL-2.0)
Fix image logo and titles. 2020-09-01 23:54:17 +00:00			`# [![htop](htop.png)](https://htop.dev)`
link to the official website, paypal donate button 2016-02-11 18:17:00 +00:00
Documentation updates to reflect community maintainership Document the htop.dev site, #htop and htop@groups.io for contacting the community maintainers, and the upcoming 3.0.0 release. 2020-08-20 03:16:31 +00:00			`[![CI](https://github.com/htop-dev/htop/workflows/CI/badge.svg)](https://github.com/htop-dev/htop/actions)`
Update link to Coverity project, still pending. 2020-08-27 00:42:40 +00:00			`[![Coverity Scan Build Status](https://scan.coverity.com/projects/21665/badge.svg)](https://scan.coverity.com/projects/21665)`
Documentation updates to reflect community maintainership Document the htop.dev site, #htop and htop@groups.io for contacting the community maintainers, and the upcoming 3.0.0 release. 2020-08-20 03:16:31 +00:00			`[![Mailing List](https://img.shields.io/badge/Mailing%20List-htop-blue.svg)](https://groups.io/g/htop)`
			`[![IRC #htop](https://img.shields.io/badge/IRC-htop-blue.svg)](https://webchat.freenode.net/#htop)`
			`[![Github Release](https://img.shields.io/github/release/htop-dev/htop.svg)](https://github.com/htop-dev/htop/releases/latest)`
Add a badge/link to the released source tarballs 2020-08-31 06:12:44 +00:00			`[![Download](https://api.bintray.com/packages/htop/source/htop/images/download.svg)](https://bintray.com/htop/source/htop/_latestVersion)`
a nicer look 2014-04-05 22:56:35 +00:00
Fix image logo and titles. 2020-09-01 23:54:17 +00:00			`## Introduction`
Initial import. 2006-03-04 18:16:49 +00:00
Documentation updates to reflect community maintainership Document the htop.dev site, #htop and htop@groups.io for contacting the community maintainers, and the upcoming 3.0.0 release. 2020-08-20 03:16:31 +00:00			`htop` is a cross-platform interactive process viewer.
			It requires `ncurses`.

			For more information and details on how to contribute to `htop`
			`visit [htop.dev](https://htop.dev).`

Fix image logo and titles. 2020-09-01 23:54:17 +00:00			`## Build instructions`
Initial import. 2006-03-04 18:16:49 +00:00
			`This program is distributed as a standard autotools-based package.`
chore: add clarification to the docs 2019-01-26 14:56:19 +00:00			`For detailed instructions see the [INSTALL](/INSTALL) file, which`
			is created after `./autogen.sh` is run.
Minor tweaks to the README 2016-02-11 19:20:50 +00:00
Documentation updates to reflect community maintainership Document the htop.dev site, #htop and htop@groups.io for contacting the community maintainers, and the upcoming 3.0.0 release. 2020-08-20 03:16:31 +00:00			`When compiling from a [release tarball](https://github.com/htop-dev/htop/releases/), run:`
Minor tweaks to the README 2016-02-11 19:20:50 +00:00
Fix image logo and titles. 2020-09-01 23:54:17 +00:00			`~~~ shell`
			`./configure && make`
			`~~~`
Minor tweaks to the README 2016-02-11 19:20:50 +00:00
			`For compiling sources downloaded from the Git repository, run:`
add travis badge, code formatting, updated compilation instructions 2016-02-11 13:59:45 +00:00
Fix image logo and titles. 2020-09-01 23:54:17 +00:00			`~~~ shell`
			`./autogen.sh && ./configure && make`
			`~~~`
add travis badge, code formatting, updated compilation instructions 2016-02-11 13:59:45 +00:00
don't mention installing to /usr 2016-02-11 16:32:06 +00:00			By default `make install` will install into `/usr/local`, for changing
			the path use `./configure --prefix=/some/path`.
add travis badge, code formatting, updated compilation instructions 2016-02-11 13:59:45 +00:00
			See the manual page (`man htop`) or the on-line help ('F1' or 'h'
			inside `htop`) for a list of supported key commands.

			`## License`
Initial import. 2006-03-04 18:16:49 +00:00
add travis badge, code formatting, updated compilation instructions 2016-02-11 13:59:45 +00:00			`GNU General Public License, version 2 (GPL-2.0)`