Getting UgMisc

The public UgMisc Git repository is hosted at Codeberg.

When a release is made on Codeberg, which has not happened yet, you will also be able to download a release tarball and OpenPGP signature.

Using the headers

The headers can simply be included and should work, although it is possible to add extra feature detection tests to your build scripts to help if necessary. You can find out more about that in the `features.hpp` documentation.

Wherever you put the source tree, whether you checked it out of the repository or unpacked a release archive, just add ${SOURCE_ROOT}/src to your include path.

Using installed headers

UgMisc may be installed. See the section below for instructions for installing it yourself.

When UgMisc is installed, it will be installed with a pkg-config file.

Using as a Meson subproject

If using Meson, it is convenient to use UgMisc as a subproject. Either copy the source into subprojects/, or use a wrap file. UgMisc is not (yet?) in the WrapDB, but you can generate a wrap file from the source using wrapfile.py.

$ path/to/ugmisc/tools/wrapfile.py git > my/project/subprojects/ugmisc.wrap

This wrap file will fetch the same version of UgMisc that generated it, directly from the main repository.

$ WRAPFILE_TEST=1 path/to/ugmisc/clone/workdir/tools/wrapfile.py git

The wrap file generated when the environment variable WRAPFILE_TEST is defined will fetch UgMisc from the repository it was generated in, using a file: url.

This feature was meant for testing wrapfile.py but may be useful for other reasons.

Now UgMisc can be used as a subproject directly, or as a fallback for a call to dependency(). It provides two dependencies: a normal one, and one which performs compiler tests to augment the features.hpp header, as described in the header's documentation.

Installing

UgMisc only installs headers and a pkg-config file, so when setting up a build directory just for the purpose of installing, compiler related options make no difference; they are only relevant if running the unit tests. In the simplest case:

$ meson setup build/dir path/to/source
$ meson install -C build/dir
$ # Or alternatively
$ # cd build/dir && meson install

If you want to install the samples too, there is a configure option for that: There aren't actually any samples yet.

$ meson setup build/dir path/to/source -Dinstall-samples=true