Skip to content

Commit 684b714

Browse files
committed
Update documentation to address #125 and #126
1 parent 70056b2 commit 684b714

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Sources/SwiftCrossUI/SwiftCrossUI.docc/DefaultBackend.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The beauty of SwiftCrossUI is that you can write your app once and have it look
88

99
> Tip: If you're using DefaultBackend, you can override the underlying backend during compilation by setting the `SCUI_DEFAULT_BACKEND` environment variable to the name of the desired backend. This is useful when you e.g. want to test the Gtk version of your app while using a Mac. Note that this only works for built-in backends and still requires the chosen backend to be compatible with your machine.
1010
11+
> Warning: When using `SCUI_DEFAULT_BACKEND` to switch underlying backends, you may encounter some linker-related missing symbol errors. These are caused by a SwiftPM bug and usually disappear if you run `swift package clean` before attempting to build your app again.
12+
1113
## Usage
1214

1315
```swift
@@ -33,7 +35,7 @@ Figure 1: *adding `DefaultBackend` to an executable target*
3335

3436
```swift
3537
import SwiftCrossUI
36-
import Backend
38+
import DefaultBackend
3739

3840
@main
3941
struct YourApp: App {

0 commit comments

Comments
 (0)