From 1a3396da3b0de7488a18f90d0bee41d8ff5970db Mon Sep 17 00:00:00 2001 From: Simon Hausmann Date: Tue, 15 Dec 2020 18:28:04 +0100 Subject: [PATCH] Recommend the use of Ninja when using CMake --- api/sixtyfps-cpp/README.md | 3 +++ docs/building.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/api/sixtyfps-cpp/README.md b/api/sixtyfps-cpp/README.md index d6aa0d838..20304476d 100644 --- a/api/sixtyfps-cpp/README.md +++ b/api/sixtyfps-cpp/README.md @@ -15,6 +15,9 @@ SixtyFPS is still in the early stages of development: APIs will change and impor SixtyFPS comes with a CMake integration that automates the compilation step of the `.60` markup language files and offers a CMake target for convenient linkage. +*Note*: We recommend using the Ninja generator of CMake for the most efficient build and `.60` dependency tracking. +You can select the CMake Ninja backend by passing `-GNinja` or settig the `CMAKE_GENERATOR` environment variable to `Ninja`. + ### Building from Sources The recommended and most flexible way to use the C++ API is to build SixtyFPS from sources. diff --git a/docs/building.md b/docs/building.md index fe14cc4f0..0e4499c12 100644 --- a/docs/building.md +++ b/docs/building.md @@ -44,7 +44,7 @@ This is just a normal cmake build. ```sh mkdir cppbuild && cd cppbuild -cmake .. +cmake -GNinja .. cmake --build . ```