slint/docs/tutorial
Simon Hausmann 3f53ce2f92 Re-organize the last page of the tutorial
Based on the reddit feedback, add links to the API docs and restructure
the list a little.
2022-03-17 21:32:33 +01:00
..
cpp Re-organize the last page of the tutorial 2022-03-17 21:32:33 +01:00
rust Re-organize the last page of the tutorial 2022-03-17 21:32:33 +01:00
theme Fix broken symlink 2022-02-09 16:56:13 +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.