slint/docs/tutorial/README.md
Tobias Hunger e01bd87df8 Janitor: Fix warnings about markdown files
These might change the layout of the rendered markdown files. This will
also fix some typos along the way:-)
2021-06-28 08:32:25 +02:00

32 lines
905 B
Markdown

# 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`:
```sh
cargo install mdbook
```
# Building
To build the tutorial, go into either the `rust` or `cpp` sub-directory and run:
```sh
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`.