Updated build instructions

Signed-off-by: Fabian Sauter <sauter.fabian@mailbox.org>
This commit is contained in:
Fabian Sauter 2022-06-24 16:21:45 +02:00
parent 7e55c076d4
commit 9de0847911

View file

@ -2,13 +2,18 @@
C++ Build System Deep Dive
======================
The recommended approach to build the project is as out-of-source build in the ``build`` folder. This project comes with a ``Makefile`` that provides a set of commands that help with developer workflows. You can see some of the commands if you want to add some of the more advanced commands.
The recommended approach to build the project is as out-of-source build in the ``build`` folder. This project uses CMake as build system.
For a base build you just have to run:
.. code-block::
.. code-block:: bash
cmake -Bbuild
git clone https://github.com/KomputeProject/kompute.git
cd kompute
mkdir build
cd build
cmake ..
cmake --build .
This by default configures without any of the extra build tasks (such as building shaders) and compiles without the optional dependencies. The table below provides more detail.