Skip to content

Companion library for GLib containing a collection of convenience functions and classes.

License

Notifications You must be signed in to change notification settings

avojak/libcatalyst

Repository files navigation

CI Lint GitHub GitHub release (latest SemVer) Documentation

Catalyst

Catalyst is a companion library for GLib containing a collection of convenience functions and classes.

Each function and class originated from scenarios I've come across and decided would be beneficial in a library like this.

API documentation is available at: https://avojak.com/libcatalyst/catalyst-1/

Features

And lots more!

Example Usage

If using Meson, simply add the dependency after installation:

dependency('catalyst-1', version: '>= 1.0.0')

Building, Testing, and Installation

Run meson build to configure the build environment:

meson build --prefix=/usr

This will create a build directory.

To build and install Catalyst, use ninja:

ninja -C build install

To run tests:

ninja -C build test

There's also a Makefile if you're lazy like me and don't want to type those commands all the time.

Demo

Some features are demonstrated through a simple demo application. To run the demo after installation:

catalyst-1-demo

Documentation

The additional requirements for building the documentation are:

  • valadoc

To generate the valadoc documentation, pass the additional -Ddocumentation=true flag to Meson, and then run ninja as before.