..
    Copyright (c) 2026 Tobias Erbsland - Erbsland DEV. https://erbsland.dev
    SPDX-License-Identifier: Apache-2.0

.. index::
    !single: usage

*****
Usage
*****

.. toctree::
    :maxdepth: 3
    :hidden:

    integrate-as-submodule
    install-as-library
    run-unit-tests

This chapter shows how to consume the library from source, how to install it as a static library, and how to run the
extracted unit tests while working on the terminal and geometry modules.

.. grid:: 1
    :margin: 4 4 0 0
    :gutter: 1

    .. grid-item-card:: :fas:`code-branch;sd-text-success` Integrate as Submodule
        :link: integrate-as-submodule
        :link-type: doc

        Learn the recommended way to include the library as a Git submodule for seamless project integration and version control.

    .. grid-item-card:: :fas:`cogs;sd-text-success` Install as a Static Library
        :link: install-as-library
        :link-type: doc

        Prefer a standalone library? This guide walks you through building and installing a static library.

    .. grid-item-card:: :fas:`vial;sd-text-success` Run Unit Tests
        :link: run-unit-tests
        :link-type: doc

        Validate your setup and contribute confidently by running the unit tests.