Welcome
=======

.. _lefticus: https://twitter.com/lefticus
.. _cpp_starter_project: https://github.com/lefticus/cpp_starter_project
.. _KDE extra-cmake-modules: https://github.com/KDE/extra-cmake-modules
.. _conan: https://conan.io
.. _c++ template repository: https://git.dotcircle.dev/templates/cpp

This project is heavily inspired an to be honest mostly just copied from the
`lefticus`_ `cpp_starter_project`_.
The `KDE extra-cmake-modules`_ have been an inspiration as how to move the cmake
modules out into their own repository with conan support.

This specific project includes all the CMake modules.
It is different from the `cpp_starter_project`_ in the way that the CMake
modules and the various c++ templates are split across different repositories.
With this repository containing the CMake modules. A usage example, and the
various c++ templates can be found in the `c++ template repository`_.

The advantage being that the CMake modules can be installed as a `conan`_
package, and therefore easily updates in the future.

In this documentation we'll describe the CMake modules, how to use and how to
configure them.
The documentation of the c++ templates can be found `here <https://templates.dotpages.co/cpp>`_.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 3

   self
   usage
   changelog