From 9de0847911fa0e22726adfa3b327eb681223f47c Mon Sep 17 00:00:00 2001 From: Fabian Sauter Date: Fri, 24 Jun 2022 16:21:45 +0200 Subject: [PATCH] Updated build instructions Signed-off-by: Fabian Sauter --- docs/overview/build-system.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/overview/build-system.rst b/docs/overview/build-system.rst index 9b90a350f..a508125cb 100644 --- a/docs/overview/build-system.rst +++ b/docs/overview/build-system.rst @@ -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.