WinUI for Swift
Documentation
ยท
Code
_WinUI for Swift_ is a framework for creating user interfaces for Windows with an API similar to SwiftUI.
## Table of Contents
- [Installation][4]
- [Usage][5]
- [Thanks][6]
## Installation
### Dependencies
Install Swift following the [official instructions for Windows](https://www.swift.org/install/windows/).
Then, download and run the installer for the Windows App SDK from the following link:
https://aka.ms/windowsappsdk/1.5/1.5.240205001-preview1/windowsappruntimeinstall-x64.exe
### Swift Package
1. Open your Swift package in VS Code or any other editor.
2. Open the `Package.swift` file.
3. Into the `Package` initializer, under `dependencies`, paste:
```swift
.package(url: "https://git.apaorksha.dev/aparoksha/winui-swift", from: "0.1.0")
```
## Usage
Find more information in the [documentation](https://winui-swift.aparoksha.dev/documentation/winui_swift/).
## Thanks
### Dependencies
- [Meta](https://git.aparoksha.dev/aparoksha/meta) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/meta/src/branch/main/LICENSE.md)
- [Levenshtein Transformations](https://git.aparoksha.dev/aparoksha/levenshtein-transformations) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/levenshtein-transformations/src/branch/main/LICENSE.md)
- [swift-winui](https://github.com/thebrowsercompany/swift-winui) licensed under the [BSD 3-Clause License](https://github.com/thebrowsercompany/swift-winui/blob/main/LICENSE)
- [swift-windowsappsdk](https://github.com/thebrowsercompany/swift-windowsappsdk) licensed under the [BSD 3-Clause License](https://github.com/thebrowsercompany/swift-windowsappsdk/blob/main/LICENSE)
- [swift-windowsfoundation](https://github.com/thebrowsercompany/swift-windowsfoundation) licensed under the [BSD 3-Clause License](https://github.com/thebrowsercompany/swift-windowsfoundation/blob/main/LICENSE)
### Other Thanks
- [DocC](https://github.com/swiftlang/swift-docc) used for generating the documentation
- [SwiftLint][21] for checking whether code style conventions are violated
- The programming language [Swift][22]
[1]: Tests/
[2]: #goals
[4]: #installation
[5]: #usage
[6]: #thanks
[7]: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/index.html
[8]: https://docs.gtk.org/gtk4/
[9]: https://github.com/AparokshaUI/Adwaita/issues
[10]: https://github.com/AparokshaUI/Libadwaita
[11]: https://brew.sh
[12]: user-manual/GettingStarted.md
[13]: user-manual/Basics/HelloWorld.md
[14]: user-manual/Basics/CreatingViews.md
[15]: user-manual/Basics/Windows.md
[16]: user-manual/Basics/KeyboardShortcuts.md
[17]: user-manual/Advanced/CreatingWidgets.md
[18]: https://github.com/CoreOffice/XMLCoder
[19]: https://github.com/CoreOffice/XMLCoder/blob/main/LICENSE
[20]: Contributors.md
[21]: https://github.com/realm/SwiftLint
[22]: https://github.com/apple/swift
[23]: https://github.com/SourceDocs/SourceDocs