slint/docs/tutorial
Olivier Goffart 7c3555e280 Update the version number that shows in the documentation
It does not update the version number in the README because
these are either not part of the versionized documentation
or the demantic versioning make it work anyway
2021-08-19 09:57:13 +02:00
..
cpp Update the version number that shows in the documentation 2021-08-19 09:57:13 +02:00
rust Update the version number that shows in the documentation 2021-08-19 09:57:13 +02:00
theme Cleanup: Move docs/html to docs/resources 2021-07-08 07:01:51 +02: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.