slint/docs/tutorial
Simon Hausmann a5bea16596
Add Ninja to the list of required tools (#2498)
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

Co-authored-by: Olivier Goffart <olivier.goffart@slint-ui.com>
2023-04-11 16:35:28 +02:00
..
cpp Add Ninja to the list of required tools (#2498) 2023-04-11 16:35:28 +02:00
node tutorial, remove hardcoded release from url 2023-04-03 07:40:07 +02:00
rust memory tutorial: fix build errors when accessing the memory tiles from native code 2023-04-06 10:56:12 +02:00
theme docs: Use it's, etc. more consistently (#2287) 2023-02-24 17:42:22 +01:00
.gitignore Initial conversion of the memory game tutorial to mdbook 2021-06-15 14:38:40 +02:00
README.md Janitor: Fix warnings about markdown files 2021-06-28 08:32:25 +02:00

Tutorials

The source code for the Rust and C++ versions of the Memory Game tutorial are located in the respect rust and cpp sub-directories. They are built using mdbook.

Requirements

Building the tutorial requires mdbook, which you can install with cargo:

cargo install mdbook

Building

To build the tutorial, go into either the rust or cpp sub-directory and run:

mdbook build

The output will be in the book/html subdirectory. To check it out, open it in your web browser.

Code Samples

The code in the tutorial is available in separate steps in .rs and .cpp files.

The .rs files are mapped to different binaries, so you if you change into the rust/src sub-directory, then cargo run will present you with binaries for the different steps.

The .cpp files are built using cpp/src/CMakeLists.txt, which is included from the top-level CMakeLists.txt.