From 4668db21b164214a41cd92658d08ee5e80b2b5ff Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 11:31:08 +0100 Subject: Improve build system and doc --- INSTALL | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index 19c0276..378a4d1 100644 --- a/INSTALL +++ b/INSTALL @@ -4,48 +4,45 @@ Build Instructions * Requirements ------------ - - A POSIX-compliant set of utils - - A set of OS specific utils - - s6 https://skarnet.org/software/s6/ - - s6-rc https://skarnet.org/software/s6-rc/ + - A set POSIX-compliant and OS specific utils, see https://0x53.net/software/requirements.html + - mdevd https://skarnet.org/software/mdevd/ - execline https://skarnet.org/software/execline/ - This software will run on any operating system that implements -POSIX.1-2008, available at: - https://pubs.opengroup.org/onlinepubs/9699919799/ +This software will run on any operating system +that runs the requirements above. * Standard usage -------------- - ./configure && make && sudo make install + ./configure && make && make install - will work for most users. +will work for most users. * Customization ------------- - You can customize paths via flags given to configure. - See ./configure --help for a list of all available configure options. +You can customize paths via flags given to configure. +See ./configure --help for a list of all available configure options. * Make variables -------------- - You can invoke make with a few variables for more configuration. +You can invoke make with a few variables for more configuration. - INSTALL can be overridden on the make command line. This is +INSTALL can be overridden on the make command line. This is an even bigger hammer than running ./configure with environment variables, so it is advised to only do this when it is the only way of obtaining the behaviour you want. - DESTDIR can be given on the "make install" command line in order to +DESTDIR can be given on the "make install" command line in order to install to a staging directory. * The slashpackage convention --------------------------- - The slashpackage convention (http://cr.yp.to/slashpackage.html) +The slashpackage convention (http://cr.yp.to/slashpackage.html) is a package installation scheme that provides a few guarantees over other conventions such as the FHS, for instance fixed absolute pathnames. skarnet.org packages support it: use the @@ -66,7 +63,7 @@ location in the filesystem) --prefix is pretty much ignored when you use --enable-slashpackage. You should probably not use both --enable-slashpackage and --prefix. - When using slashpackage, two additional Makefile targets are +When using slashpackage, two additional Makefile targets are available after "make install": - "make update" changes the default version of the software to the freshly installed one. (This is useful when you have several installed @@ -78,6 +75,6 @@ default version of the binaries and shared libraries. * Out-of-tree builds ------------------ - This package does not support out-of-tree builds. It +This package does not support out-of-tree builds. It is small, so it does not cost much to duplicate the entire source tree if parallel builds are needed. -- cgit v1.2.3