README: list the development packages required to build the library
authorBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Fri, 5 Jul 2024 07:33:14 +0000 (09:33 +0200)
committerBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Mon, 8 Jul 2024 08:24:00 +0000 (10:24 +0200)
The error messages emitted by configure when either libtool, pkg-config
or autoconf-archive packages are missing on the host are not very clear
and seem to cause confusion among users building the project from
sources. List the required packages in the README.

Reviewed-by: Kent Gibson <warthog618@gmail.com>
Link: https://lore.kernel.org/r/20240705073314.5728-1-brgl@bgdev.pl
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
README

diff --git a/README b/README
index a6f24d1c97ea3a0126cf695a3371862d31841af0..a01cfc5329c68ed0dd8ca01bd32cdf9c0ae1f17b 100644 (file)
--- a/README
+++ b/README
@@ -34,6 +34,11 @@ BUILDING
 This is a pretty standard autotools project. The core C library does not have
 any external dependencies other than the standard C library with GNU extensions.
 
+The build system requires autotools, autoconf-archive, libtool and pkg-config
+to be installed on the host system for the basic build. Development files for
+additional libraries may be required depending on selected options. The
+configure script will report any missing additional required dependencies.
+
 The command-line tools optionally depend on libedit for the interactive feature.
 
 To build the project (including command-line utilities) run: