JLib

A general-purpose C Library

About

This project is a general-purpose C library. It is intended to be used in other projects, and is not meant to be used as a standalone program.

Note: This project is meant to be educational. It can be used in production. However, please make sure to read the code and understand what it does before using it in production.

Features

Please refer to the documentation for a list of features. See Usage.

Installation

Usage

Compiling

To compile the library, run the following command:

make

Alternatively, you can run the following command:

make build/static

Note: This will create a static library. If you want to create a shared library, run make build/dynamic instead.

Documentation

The documentation can be created using Doxygen. To create the documentation, run the following command:

make docs

Then, open docs/html/index.html in your browser.

Tests

The tests can be compiled and run using the following command:

make tests

Debugging

The library can be debugged (using Valgrind) using the following command:

make debug

Note: If you need to use debug in a workflow, you can use make debug/headless instead.

Cleaning

To clean the project, run the following command:

make clean

Alternatively, you can run the following command:

make clean/objects clean/lib clean/exec clean/docs clean/debug

Installing

To install the dependencies, run the following command:

make install/debian

Note: This will install the dependencies for Debian-based systems. If you are using a different system, please install the dependencies manually :(

License

This work is licensed under the MIT License. See LICENSE for more information.

Contributors

• 2023-2024: Josselin Dulongcourty