libglacier/README

+ libglacier

The underlying C libraries for the Glacier package manager

+ Rationale

Glacier has been written in Bash since its conception. For obvious reasons, this is terrible for portability.
While writing an entire library for a project that's been in the works for a year at this point will take
much more time, it should futureproof Glacier and make it easier to deploy and test.

+ Usage

	#include <glacier_config.h>
	#include <glacier_log.h>
	#include <glacier_pkgops.h>
	#include <glacier_runtime.h>

See the relevant documentation for more information on libglacier functions.

+ Installation

Libglacier requires the following libraries to compile:

	- libcolor
	- libconfig

Once these are installed, you can continue with the installation.

Clone this repository:

	$ git clone https://git.everestlinux.org/EverestLinux/libglacier

Enter the directory and edit config.mk:

	$ cd libglacier
	$ $EDITOR config.mk

Build the library:

	$ make

NOTE: libglacier is distributed as a static library only.

Install the library and header files:

	# make install

+ Linking

To link libglacier into your program, ensure the proper header files are included.
Then simply add the following to your compiler flags:

	-lglacier

+ Documentation

Online documentation can be found at https://everestlinux.org/docs/libglacier
Offline documentation can be accessed with the following command:

	$ man libglacier