This GitLab instance will be migrated to gitlab.mel.vin before 2020-06-01 and will lose the shared runners, setup your own runners if needed.

Commit 47540813 authored by Vermeeren's avatar Vermeeren

cmake: improve main index with a quick start

parent 1068cf00
CMake options
=============
CMake build system
==================
Below is a list of all possible options that can be configured in CMake. Their
effect on the build and integrations with other options is also described.
.. toctree::
:glob:
*
In case you haven't used CMake before, there are three tools to configure:
* ``cmake``
......@@ -13,7 +18,20 @@ In case you haven't used CMake before, there are three tools to configure:
* ``cmake-gui``
* Qt interface, can see the options and select them
.. toctree::
:glob:
Typically an interactive interface is used, unless CMake is being used in a
script or similar automated style. Below example uses ``ccmake`` in a Unix-like
environment. Using ``cmake-gui`` is also possible, no command line is needed in
that case.
*
.. code-block:: console
# the current directory must be the root of the repo
mkdir build
cd build
# configure, set desired options, configure and generate
ccmake ..
# from here on it depends on the generator used
# below example is for the "Unix Makefiles" generator
make help
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment