Minor README wordsmithing on review of recent deps/build changes

This commit is contained in:
Nathan Scott 2021-07-16 12:47:12 +10:00
parent 0b787ca0b8
commit c9abd788b1

19
README
View File

@ -29,14 +29,14 @@ List of build-time dependencies:
* `build-essential` standard GNU autotools-based
* `autoconf`
* `autotools`
* `ncurses` (libncursesw*-dev)
* `ncurses`
**Note about `ncurses`:**
> htop requires ncurses 6.0, the appropriate package is often enough still called libncurses5 (+-dev for headers). Also ncurses usually comes in two flavours:
> htop requires ncurses 6.0. Be aware the appropriate package is sometimes still called libncurses5 (on Debian/Ubuntu). Also ncurses usually comes in two flavours:
>* With Unicode support.
>* Without Unicode support.
>
> This is also something that is usually reflected in the package name (the additional w).
> This is also something that is reflected in the package name on Debian/Ubuntu (via the additional 'w' - 'w'ide character support).
List of additional build-time dependencies (based on feature flags):
* `sensors`
@ -50,8 +50,13 @@ Compiling `htop` requires the header files for `ncurses` . Install these and oth
sudo apt install libncursesw5-dev autotools-dev autoconf
~~~
**Fedora/RHEL**
~~~ shell
sudo dnf install ncurses-devel automake autoconf
~~~
### Compiling from source:
To compiling from sources downloaded from the Git repository (`git clone` or downloads from [Github releases](https://github.com/htop-dev/htop/releases/)), then run:
To compile from sources downloaded from the Git repository (`git clone` or downloads from [Github releases](https://github.com/htop-dev/htop/releases/)), then run:
~~~ shell
./autogen.sh && ./configure && make
~~~
@ -59,7 +64,7 @@ To compiling from sources downloaded from the Git repository (`git clone` or dow
By default `make install` will install into `/usr/local`, for changing the path use `./configure --prefix=/some/path`.
### Install
To install to system run `make install`. By default `make install` installs into `/usr/local`. To change this path use `./configure --prefix=/some/path`.
To install on the local system run `make install`. By default `make install` installs into `/usr/local`. To change this path use `./configure --prefix=/some/path`.
### Build Options
@ -71,6 +76,10 @@ To install to system run `make install`. By default `make install` installs into
enable Unicode support
dependency: *libncursesw*
default: *yes*
* `--enable-pcp`:
enable Performance Co-Pilot support via a new pcp-htop utility
dependency: *libpcp*
default: *no*
* `--enable-hwloc`:
enable hwloc support for CPU affinity; disables Linux affinity
dependency: *libhwloc*