Add Ninja to the list of required tools

We have plenty of command lines that explicitly use `-GNinja`, so let's make Ninja a tool that is required. That's easier than changing all the command lines to have two variants (use XX or YY if you have Ninja installed), and we know that the dependency handling works best with Ninja. Fixes #2495
slint-ui · Apr 6, 2023 · f709e33 · f709e33
1 parent 8b1683b
commit f709e33
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/api/cpp/README.md b/api/cpp/README.md
@@ -15,7 +15,7 @@ Slint comes with a CMake integration that automates the compilation step of the
 offers a CMake target for convenient linkage.
 
 *Note*: We recommend using the Ninja generator of CMake for the most efficient build and `.slint` dependency tracking.
-You can select the CMake Ninja backend by passing `-GNinja` or setting the `CMAKE_GENERATOR` environment variable to `Ninja`.
+Install [Ninja](https://ninja-build.org) and select the CMake Ninja backend by passing `-GNinja` or setting the `CMAKE_GENERATOR` environment variable to `Ninja`.
 
 ### Building from Sources
 

diff --git a/api/cpp/docs/cmake.md b/api/cpp/docs/cmake.md
@@ -6,7 +6,7 @@ Slint comes with a CMake integration that automates the compilation step of the
 offers a CMake target for convenient linkage.
 
 *Note*: We recommend using the Ninja generator of CMake for the most efficient build and `.slint` dependency tracking.
-You can select the CMake Ninja backend by passing `-GNinja` or setting the `CMAKE_GENERATOR` environment variable to `Ninja`.
+Install [Ninja](https://ninja-build.org) and select the CMake Ninja backend by passing `-GNinja` or setting the `CMAKE_GENERATOR` environment variable to `Ninja`.
 
 ## Binary Packages
 

diff --git a/docs/building.md b/docs/building.md
@@ -41,6 +41,7 @@ environment variable `RUST_FONTCONFIG_DLOPEN=on`. This can be useful for [cross-
 To use Slint from C++, the following extra dependencies are needed:
 
 - **[cmake](https://cmake.org/download/)** (3.21 or newer)
+- **[Ninja](https://ninja-build.org)**
 - A C++ compiler that supports C++20 (e.g., **MSVC 2022 17.3** on Windows, or **GCC 10**)
 
 ### Node.js API (optional)

diff --git a/docs/tutorial/cpp/src/getting_started.md b/docs/tutorial/cpp/src/getting_started.md
@@ -3,7 +3,7 @@
 In this tutorial, we use C++ as the host programming language. We also support other programming languages like
 [Rust](https://slint-ui.com/docs/rust/slint/) or [JavaScript](https://slint-ui.com/docs/node/).
 
-You will need a development environment that can compile C++20 with CMake 3.21.
+You will need a development environment that can compile C++20, [CMake 3.21](https://cmake.org/download/), and [Ninja](https://ninja-build.org).
 We don't provide binaries of Slint yet, so we will use the CMake integration that will automatically build
 the tools and library from source. Since it's implemented in the Rust programming language, this means that
 you also need to install a Rust compiler (1.66 or newer). You can easily install a Rust compiler