summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorDaniel Lange <DLange@git.local>2020-09-16 17:54:25 +0200
committerDaniel Lange <DLange@git.local>2020-09-16 18:10:29 +0200
commit3a1c6985789426a2bfc9c7d39eb66c143c6a1c7e (patch)
treee655e513ff957a1b38730e8582bb8e5ab7db8b31 /README
parenta2fef38be74d4022ef4510e749e4b136d4ac2c33 (diff)
Update README with correct tarball locations, ncurses hints and support / bug reporting pointers.
Closes #63 (Release URL tarballs) Closes #61, Closes #82 (Support requests on ncurses) Closes #89 (ncurses docs) Closes #28 (htop-dev vs. -legacy)
Diffstat (limited to 'README')
-rw-r--r--README48
1 files changed, 36 insertions, 12 deletions
diff --git a/README b/README
index 92bd285a..32ad7afa 100644
--- a/README
+++ b/README
@@ -10,34 +10,58 @@
## 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).
+`htop` allows scrolling the list of processes vertically and horizontally to see their full command lines and related information like memory and CPU consumption.
+
+The information displayed is configurable through a graphical setup and can be sorted and filtered interactively.
+
+Tasks related to processes (e.g. killing and renicing) can be done without entering their PIDs.
+
+Running `htop` requires `ncurses` libraries (typically named libncursesw*).
+
+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` file, which
-is created after `./autogen.sh` is run.
+This program is distributed as a standard GNU autotools-based package.
-When compiling from a [release tarball](https://github.com/htop-dev/htop/releases/), run:
+Compiling `htop` requires the header files for `ncurses` (libncursesw*-dev). Install these and other required packages for C development from your package manager.
+
+Then, when compiling from a [release tarball](https://bintray.com/htop/source/htop), run:
~~~ shell
./configure && make
~~~
-For compiling sources downloaded from the Git repository, run:
+Alternatively, for compiling sources downloaded from the Git repository (`git clone` or downloads from [Github releases](https://github.com/htop-dev/htop/releases/)),
+install the header files for `ncurses` (libncursesw*-dev) and other required development packages from your distribution's package manager. Then run:
~~~ shell
./autogen.sh && ./configure && make
~~~
-By default `make install` will install into `/usr/local`, for changing
-the path use `./configure --prefix=/some/path`.
+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.
+
+## Support
+
+If you have trouble running `htop` please consult your Operating System / Linux distribution documentation for getting support and filing bugs.
+
+## Bugs, development feedback
+
+We have a [development mailing list](https://htop.dev/mailinglist.html). Feel free to subscribe for release announcements or asking questions on the development of htop.
+
+You can also join our IRC channel #htop on freenode and talk to the developers there.
+
+If you have found an issue with the source of htop, please check whether this has already been reported in our [Github issue tracker](https://github.com/htop-dev/htop/issues).
+If not, please file a new issue describing the problem you have found, the location in the source code you are referring to and a possible fix.
+
+## History
+
+`htop` was invented, developed and maintained by Hisham Muhammad from 2006 to 2019. His [legacy repository](https://github.com/hishamhm/htop/) has been archived to preserve the history.
-See the manual page (`man htop`) or the on-line help ('F1' or 'h'
-inside `htop`) for a list of supported key commands.
+In 2020 a [team](https://github.com/orgs/htop-dev/people) took over the development amicably and continues to maintain `htop` collaboratively.
## License

© 2014-2024 Faster IT GmbH | imprint | privacy policy