summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 11:32:20 +0100
committerPS <p@0x53.net>2026-02-07 11:32:20 +0100
commita30f91e543d484375a3d50c0c690a47dcb95ea47 (patch)
tree6623f79099654e066a4921450c4ed75e40670493 /INSTALL
parent49098cf9c6055b85a4cd0dcb4a0d57fc003310f4 (diff)
downloadgoetia-linux-a30f91e543d484375a3d50c0c690a47dcb95ea47.tar.gz
goetia-linux-a30f91e543d484375a3d50c0c690a47dcb95ea47.tar.bz2
goetia-linux-a30f91e543d484375a3d50c0c690a47dcb95ea47.zip
Improve build system and doc
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL30
1 files changed, 14 insertions, 16 deletions
diff --git a/INSTALL b/INSTALL
index 19c0276..d97f748 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,48 +4,46 @@ Build Instructions
* Requirements
------------
- - A POSIX-compliant set of utils
- - A set of OS specific utils
+ - A set POSIX-compliant and OS specific utils, see https://0x53.net/software/requirements.html
+ - execline https://skarnet.org/software/execline/
- s6 https://skarnet.org/software/s6/
- s6-rc https://skarnet.org/software/s6-rc/
- - 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 +64,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 +76,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.