diff options
author | Gauthier Östervall <gauthier.ostervall@lumenradio.com> | 2023-06-23 11:59:18 +0200 |
---|---|---|
committer | Matt Turner <mattst88@gmail.com> | 2023-08-30 11:12:41 -0400 |
commit | 2cf9ae1cea805d8aaa210fe7feafb21b1cfdecdf (patch) | |
tree | 23145caf9c6976eb98edb8529d76bca43d19b439 | |
parent | 72c4245b2e4127883c71f0970b71f4dc93829e41 (diff) |
Update build instructions to meson and ninja
-rw-r--r-- | INSTALL | 107 |
1 files changed, 20 insertions, 87 deletions
@@ -10,62 +10,32 @@ unlimited permission to copy, distribute and modify it. Basic Installation ================== -Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following -more-detailed instructions are generic; see the `README' file for -instructions specific to this package. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. Caching is -disabled by default to prevent problems with accidental use of stale -cache files. - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version -of `autoconf'. +Briefly, the shell commands `meson setup build/; ninja -C build; ninja +-C build install' should configure, build, and install this package. The +following more-detailed instructions are generic; see the `README' file +for instructions specific to this package. + + Running `meson setup` attempts to guess correct values for various +system-dependent variables used during compilation. The simplest way to compile this package is: 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. + `meson setup build/' to configure the package for your system. - Running `configure' might take a while. While running, it prints - some messages telling which features it is checking for. + While running, it prints some messages telling which features it + is checking for. - 2. Type `make' to compile the package. + 2. Type `ninja -C build' to compile the package. - 3. Optionally, type `make check' to run any self-tests that come with - the package. + 3. Optionally, type `ninja -C build test' to run any self-tests that + come with the package. - 4. Type `make install' to install the programs and any data files and - documentation. + 4. Type `ninja -C build install' to install the programs and any + data files and documentation. 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. + source code directory by typing `ninja -C build clean'. Compilers and Options ===================== @@ -100,10 +70,10 @@ reconfiguring for another architecture. Installation Names ================== -By default, `make install' installs the package's commands under +By default, `ninja -C install' installs the package's commands under `/usr/local/bin', include files under `/usr/local/include', etc. You can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX'. +`meson setup' the option `--prefix=PREFIX'. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you @@ -113,7 +83,7 @@ Documentation and other data files still use the regular prefix. In addition, if you use an unusual directory layout you can give options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories +kinds of files. Run `meson setup --help' for a list of the directories you can set and what kinds of files go in them. If the package supports it, you can cause programs to be installed @@ -124,7 +94,7 @@ Optional Features ================= Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. +`meson setup', where FEATURE indicates an optional part of the package. They may also pay attention to `--with-PACKAGE' options, where PACKAGE is something like `gnu-as' or `x' (for the X Window System). The `README' should mention any `--enable-' and `--with-' options that the @@ -195,40 +165,3 @@ an Autoconf bug. Until the bug is fixed you can use this workaround: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash -`configure' Invocation -====================== - -`configure' recognizes the following options to control how it operates. - -`--help' -`-h' - Print a summary of the options to `configure', and exit. - -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. - -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. - |