aparoksha/README.md

Aparoksha

Website · Documentation · Code

Aparoksha is a Meta umbrella backend for creating cross-platform apps which render native widgets on each supported platform.

The following platforms are currently supported:

• GNOME (libadwaita/GTK)
• macOS (AppKit/SwiftUI)
• Windows (WinUI)

Discuss adding your backends via an issue or a new discussion. More information on how to create backends here.

Table of Contents

• Overview
• Usage
• Thanks

Overview

Find general information and guides on the Aparoksha website.

Usage

Follow the guides on the Aparoksha website. The reference documentation will be helpful when writing own apps.

The framework for rendering can be selected explicitly by setting the APAROKSHA_FRAMEWORK environment variable to one of the listed values. Otherwise, the platform's default will be used.

• WINUI for the WinUI framework (default on Windows)
• APPKIT for the AppKit framework (default on macOS)
• ADWAITA for the libadwaita framework (default on any other platform)

Thanks

Backends

• adwaita-swift is a dependency when selecting the ADWAITA framework
• macbackend is a dependency when selecting the APPKIT framework
• winui-swift is a dependency when selecting the WINUI framework

Other Thanks

• DocC used for the documentation
• SwiftLint for checking whether code style conventions are violated
• The programming language Swift