slint/docs
Olivier Goffart 21d60b1050 Fix the documentation of the absolute-position property
It is an `out` property (read-only)

Fixes #6174
2024-09-17 08:52:32 +02:00
..
_templates Adjust the nightly script to the fact that the cpp artifact are named differently 2024-09-14 09:04:03 +02:00
reference Fix the documentation of the absolute-position property 2024-09-17 08:52:32 +02:00
resources rust docs: fix syntax highlighting of slint code 2024-08-20 13:13:03 +02:00
site Update from slint-ui/website 2024-07-03 10:05:16 +00:00
building.md Consolidate language tutorials (#5037) 2024-06-04 16:54:36 +02:00
development.md Document the preferred linear history approach a little (#4034) 2023-11-30 11:01:53 +01:00
install_qt.md reuse: remove glob for markdown files 2023-08-17 08:55:28 +02:00
README.md Consolidate language tutorials (#5037) 2024-06-04 16:54:36 +02:00
testing.md It seems that syntax_tests.rs was moved to ./internal/compiler/tests/ 2024-03-18 14:58:41 +01:00
torizon.md doc: add missing closing single quotes 2024-06-12 09:29:33 +02:00
triage.md Update triage.md 2024-09-10 11:09:46 +02:00

Tutorials

The source code for the Rust, C++, and Node.js versions of the Memory Game tutorial are located in the respect rust, cpp, and node 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, enter the rust, cpp, or node 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, .cpp, and .js 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.