Skip to content

Commit db1dffd

Browse files
committed
Add QtBackend to Readme (with dependency installation instructions)
1 parent ba9b12f commit db1dffd

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Work is being done to allow the backend used by the examples to be changed from
3333

3434
- `GtkBackend`: Requires gtk 4 to be installed, has maximum compatibility, and supports all SwiftCrossUI features.
3535
- `AppKitBackend`: ***Experimental***, only supports macOS, and currently supports a very limited subset of SwiftCrossUI features.
36+
- `QtBackend`: ***Experimental***, requires `qt5` to be installed, and currently supports a very limited subset of SwiftCrossUI features.
3637

3738
## Example
3839

@@ -48,6 +49,7 @@ class CounterState: Observable {
4849
@main
4950
struct CounterApp: App {
5051
// An experimental AppKit backend is also available when on macOS (try AppKitBackend)
52+
// There's also a Qt5 backend (QtBackend) available when qt5 is installed
5153
typealias Backend = GtkBackend
5254

5355
let identifier = "dev.stackotter.CounterApp"
@@ -92,8 +94,20 @@ Here's the [documentation site](https://stackotter.github.io/swift-cross-ui/docu
9294
## Dependencies
9395

9496
1. Swift 5.5 or higher
95-
2. Gtk 4
96-
3. clang (only required on Linux)
97+
2. Gtk 4 (only required for GtkBackend)
98+
3. clang (only required on Linux for GtkBackend)
99+
4. Qt5 (only required for QtBackend)
100+
101+
### Installing Qt5
102+
103+
```sh
104+
# On macOS
105+
brew install qt@5
106+
brew link qt@5
107+
108+
# Linux with apt
109+
sudo apt install qtcreator qtbase5-dev qt5-qmake cmake
110+
```
97111

98112
### macOS: Installing Gtk 4
99113

0 commit comments

Comments
 (0)