mirror of
https://github.com/slint-ui/slint.git
synced 2025-10-02 06:41:14 +00:00
9345638191
* Refactor CPP Quickstart to use project template project * Update docs/tutorial/cpp/src/main_initial.cpp Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update docs/tutorial/cpp/src/game_logic_in_cpp.md Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev> * Update docs/tutorial/cpp/src/creating_the_tiles_from_cpp.md Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev> * Update docs/tutorial/cpp/src/from_one_to_multiple_tiles.md Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev> * Update docs/tutorial/cpp/src/from_one_to_multiple_tiles.md Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev> * Update docs/tutorial/cpp/src/getting_started.md Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev> * Remove commented text * Re-add removed powershell icon commands * Undo rename * Correct path in CMakeLists.txt --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev>
73 lines
1.9 KiB
Markdown
73 lines
1.9 KiB
Markdown
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->
|
|
|
|
# Getting Started
|
|
|
|
This tutorial uses C++ as the host programming language. Slint also supports other programming languages like
|
|
[Rust](https://slint.dev/docs/rust/slint/) or [JavaScript](https://slint.dev/docs/node/).
|
|
|
|
Slint has an application template you can use to create a project with dependencies already set up that follows recommended best practices.
|
|
|
|
Before using the template, you need a C++ compiler that supports C++ 20 and to install [CMake](https://cmake.org/download/) 3.21 or newer.
|
|
|
|
Clone or download template repository:
|
|
|
|
```sh
|
|
git clone https://github.com/slint-ui/slint-cpp-template memory
|
|
cd memory
|
|
```
|
|
|
|
The `CMakeLists.txt` uses the line `add_executable(my_application src/main.cpp)` to set `src/main.cpp` as the main C++ code file.
|
|
|
|
Change the content of `src/main.cpp` to the following:
|
|
|
|
```cpp
|
|
{{#include main_initial.cpp:main}}
|
|
```
|
|
|
|
Also in `CMakeLists.txt` the line
|
|
`slint_target_sources(my_application ui/appwindow.slint)` is a Slint function used to
|
|
add the `appwindow.slint` file to the target.
|
|
|
|
Change the contents of `ui/appwindow.slint` to the following:
|
|
|
|
```slint
|
|
{{#include appwindow.slint:main_window}}
|
|
```
|
|
|
|
Configure with CMake:
|
|
|
|
```sh
|
|
cmake -B build
|
|
```
|
|
|
|
Build with CMake:
|
|
|
|
```sh
|
|
cmake --build build
|
|
```
|
|
|
|
Run the application binary on Linux or macOS:
|
|
|
|
```sh
|
|
./build/my_application
|
|
```
|
|
|
|
Windows:
|
|
|
|
```sh
|
|
build\my_application.exe
|
|
```
|
|
|
|
This opens a window with a green "Hello World" greeting.
|
|
|
|
If you are stepping through this tutorial on a Windows machine, you can run it with
|
|
|
|
```sh
|
|
my_application
|
|
```
|
|
|
|
|
|
|
|
_Note_: When configuring with CMake, the FetchContent module fetches the source code of Slint via git.
|
|
This may take some time when building for the first time, as the process needs to build
|
|
the Slint runtime and compiler.
|