.. include:: defs.hrst

Quickstart
############

The following dependencies are required to build |Obscura|.

Dependencies
****************

Most dependencies are automatically downloaded and built by CMake.
This project uses CMake 3.24 or higher.
We recommend installing CMake through ``pip`` with ``pip3 install cmake`` but it can also be installed through your system's
package manager.
Besides CMake, you will need a C++20 compiler.

General dependencies
====================

* `C++20 compiler <https://en.cppreference.com/w/cpp/compiler_support#C.2B.2B20_features>`_. The following compilers are tested:
    * Clang >= 15
    * GCC >= 13
* `Python <https://www.python.org/>`_ >= 3.9
* `Vulkan <https://vulkan.lunarg.com/>`_ >= 1.3.250.0

Build
=====

For building |Obscura|.

* `CMake <https://cmake.org/>`_ >= 3.24 (recommended: `pip3 install cmake`)

Docs
====

For building the documentation of |Obscura|.

* `Doxygen <https://www.doxygen.nl/index.html>`_ >= 1.9.1 (recommended installation through package manager)
* `Sphinx <https://www.sphinx-doc.org/en/master/>`_ >= 6.2.1 (recommended: `pip3 install sphinx`)
* `Breathe <https://breathe.readthedocs.io/en/latest/>`_ >= 4.35.0 (recommended: `pip3 install breathe`)
* `Sphinx RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`_ >= 1.2.2 (recommended: `pip3 install sphinx_rtd_theme`)

Install
*******

.. note::
    Coming soon.

Build
************

By default, CMake will build the Release version of the engine. To build the Debug version, use the ``--config Debug`` flag
when building.
The tests are built by default for the Debug configuration.

.. code-block:: bash
    :caption: Building Obscura

    cmake -B build
    cmake --build build [--config Debug]

Building tests, examples, and docs
===========================

You can also build tests and examples by passing CMake config parameters to the build command.

.. code-block:: bash
    :caption: Building tests and examples

    cmake -B build -DOBSCURA_PACKAGE_TESTS=ON -DOBSCURA_BUILD_EXAMPLES=ON -DOBSCURA_BUILD_DOCS=ON
    cmake --build build [--config Debug]

The tests can then be run with:

.. code-block:: bash
    :caption: Running tests

    cd build
    ctest

Of course you can also build the tests/examples/docs individually by simply not passing the respective parameters.