.. _get-started:
.. index::
    !single: Getting started

Getting Started
===============

**Welcome! Let’s Begin Writing Your First Unit Test**

This guide will walk you through creating a small unit test for our example library using the Erbsland UnitTest framework. To get started, ensure you have:

* Your favorite C++ development environment.
* A Git client of your choice.

We’ll demonstrate using command-line tools, but you’re encouraged to use whatever tools you prefer to achieve the same results.

.. button-ref:: project-structure
    :color: success
    :align: center
    :expand:
    :class: sd-fs-5 sd-font-weight-bold sd-p-2

    Let’s get started with setting up your project! →

.. card:: ... Or Learn by Example

    Prefer to learn by example? Dive straight into this ready-to-use repository:

    .. button-link:: https://github.com/erbsland-dev/erbsland-unittest-example
        :color: info
        :align: center
        :outline:
        :expand:

        Explore the Example Repository

    This repository contains a fully functional example, showcasing best practices for structuring and using the Erbsland UnitTest framework.

**Navigate the Chapter**

Use the green button in each section to follow the step-by-step guide and set up your first test. Alternatively, jump directly to one of the following sections:

.. toctree::
    :maxdepth: 1

    01-project-structure
    02-cmake-configuration
    03-write-the-test
    04-build-the-test
    05-run-the-test
    06-whats-next